2020年12月10日

API文档实践

摘要: 好的API文档不是随意就可以生成的。它需要明确的指导方案、团队一致的努力、严格的用户评审以及在API的整个生命周期中维护文档。如果需要编写的好的API文档则应该包括: **必要的组件。**完整的文档通常包含有参数说明、错误消息、响应信息、示例,以及全面的更改日志的部分。一些API文档还包括一系列指南 阅读全文

posted @ 2020-12-10 18:11 隔壁王书 阅读(139) 评论(0) 推荐(0) 编辑

规范管理提高效率——国内主要api接口文档工具盘点

摘要: 现在开发越来越流行前后端分离架构,使用ajax交互。这时候api接口文档就变的更有意义了。下面盘点一下目前国内市场上比较优秀的接口文档管理工具。 1、 EoLinker 网址:https://www.eolinker.com/ EoLinker拥有业内最强的接口管理功能,无论你是创业团队还是成熟企业 阅读全文

posted @ 2020-12-10 18:01 隔壁王书 阅读(554) 评论(0) 推荐(0) 编辑

导航