API文档实践
摘要:
好的API文档不是随意就可以生成的。它需要明确的指导方案、团队一致的努力、严格的用户评审以及在API的整个生命周期中维护文档。如果需要编写的好的API文档则应该包括: **必要的组件。**完整的文档通常包含有参数说明、错误消息、响应信息、示例,以及全面的更改日志的部分。一些API文档还包括一系列指南 阅读全文
posted @ 2020-12-10 18:11 隔壁王书 阅读(139) 评论(0) 推荐(0) 编辑
posted @ 2020-12-10 18:11 隔壁王书 阅读(139) 评论(0) 推荐(0) 编辑
posted @ 2020-12-10 18:01 隔壁王书 阅读(554) 评论(0) 推荐(0) 编辑