我有个朋友他这个 18 线小公司写 API 文档这个流程也太繁琐了

2022-10-11 08:26:54 +08:00
 xoxo419

开发一个 API 功能的流程

  1. 写数据库字段描述文档
  2. 写代码模型(这个时候又要把字段描述复制一次到代码模型中)
  3. 写好逻辑开始测试, 然后又要把 model 字段复制到 postman 这类的接口调试工具中去调试
  4. 测试好后开始给前端写文档(这个时候又要把返回字段和参数再次复制字段描述)

写一个 API ，重复 4 次，这也太繁琐了。。

大家估计只写一次吧，有啥工具可以推荐下给他呢

3979 次点击
所在节点    问与答
21 条回复
tim9527
2022-10-11 14:32:07 +08:00
我也是小公司，我都不写的。。。

这是一个专为移动设备优化的页面（即为了让你能够在 Google 搜索结果里秒开这个页面），如果你希望参与 V2EX 社区的讨论，你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/885946

V2EX 是创意工作者们的社区，是一个分享自己正在做的有趣事物、交流想法，可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX