2021年1月16日

API文档自动生成的方法

摘要: 编写API文档是API编写人员的噩梦,而API文档通常是由API研发人员编写。由于API文档创建繁琐,需要记录的内容比较广,结束了API开发任务后,还要仔细编写API文档,给研发人员带来额外的工作量。 随着需求量越来越高,工具的诞生让API的研发与API文档之间的联系更加紧密。例如:Swagger、 阅读全文

posted @ 2021-01-16 23:51 隔壁王书 阅读(1086) 评论(0) 推荐(0) 编辑

快速对比API版本

摘要: 为了记录项目每次更新迭代,往往会对项目进行编号,每个编号代表一个项目版本。记录项目版本可清楚的了解每次更新的详细内容,例如对某个功能进行了某些更改,或新增了某些功能。 如今,项目已逐渐API化,对项目的更新迭代就是对API的更新迭代。项目API化的好处之一是API方便记录为文档形式,从一开始使用of 阅读全文

posted @ 2021-01-16 23:48 隔壁王书 阅读(258) 评论(0) 推荐(0) 编辑

导航