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

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.

主站蜘蛛池模板: 工布江达县| 青海省| 丹棱县| 巴里| 金塔县| 广水市| 南部县| 枣强县| 东乡县| 乌鲁木齐市| 娄底市| 宁南县| 巧家县| 洪湖市| 丰都县| 西安市| 萍乡市| 青川县| 大方县| 绥棱县| 偏关县| 信丰县| 天台县| 新和县| 登封市| 漳州市| 大荔县| 清徐县| 莱芜市| 淮阳县| 万山特区| 香河县| 肇源县| 石狮市| 衡阳县| 玉溪市| 茶陵县| 宁南县| 阿合奇县| 苏尼特左旗| 鹰潭市|