官术网_书友最值得收藏!

The API page

The API page is the one-stop-shop for all API related documentation. It consists of two main sections. The landing section displaying the API overview documentation and the API documentation section that displays the API Blueprint or Swagger document created in Apiary for the API.

Creating comprehensive API overview and Apiary documentation (API Blueprint or Swagger) is extremely important as this is what application developers will be looking at when consuming an API.

The better the documentation, the more usage the API will receive. If the API is poorly documented, application developers will avoid its use by finding workaround which could even imply creating new APIs.

Developer Portal – API page

From this page, the API documentation can be accessed (icon with shape of a document located on the left-hand side of the section) as well as a subscription for the API can be created.

主站蜘蛛池模板: 田东县| 峨眉山市| 金平| 华宁县| 稷山县| 宝应县| 漳平市| 吉安县| 东乡族自治县| 新建县| 孙吴县| 松阳县| 容城县| 柘城县| 普洱| 霍林郭勒市| 库尔勒市| 清新县| 思茅市| 田阳县| 麻栗坡县| 洞头县| 平山县| 鸡东县| 宣武区| 宜城市| 贺州市| 常州市| 喀喇沁旗| 二手房| 昌宁县| 枣强县| 布尔津县| 安远县| 大同市| 漠河县| 饶河县| 霍林郭勒市| 南华县| 福建省| 剑阁县|