无论哪种类型的Web API, 都可能需要给其他开发者使用. 所以API的开发者体验是很重要的. API的开发者体验, 简写为 API DX (Developer Experience)....它包含很多东西, 例如如何使用API, 文档, 技术支持等等, 但是最重要的还是API的设计. 如果 API 设计的不好, 那么使用该API构建的软件就需要增加在时间,人力,金钱等方面的投入....有时候API会被错用, 甚至带来毁灭性后果. 最后抱怨该API等用户越来越多, 慢慢的, 客户就会停止使用该API.
API的目的是让人们可以简单的使用它来达到自己的目的....很多人使用Excel或者纸和笔来进行API的设计工作. 但是如果想要在设计阶段精准描述一个API, 尤其是它的数据, 那么最好使用一个结构化的工具, 例如API描述格式....生成代码
使用API描述格式进行描述的API, 其代码也可以部分生成. 通常是一个代码骨架.
什么时候使用API描述格式
肯定是在设计接口如何表达API目标和概念, 以及数据的时候.