乐趣区

关于开源软件:就这些了-常见-6-款API-文档工具推荐

jiezi

8 年开发教训，想分享一下我接触到这些 API 文档工具：

  1. Swagger: Swagger 是一个开源的 API 文档管理工具，能够通过注解主动生成 API 文档，并提供交互式 UI 和 API 调试性能。Swagger 反对多种语言和格局，包含 Java、Python、JSON、YAML 等。
  2. Postman: Postman 是一个罕用的 API 开发和测试工具，同时也提供了 API 文档治理性能。用户能够通过 Postman 的界面编写 API 文档，并反对多种格局和导出选项。
  3. Apidoc: Apidoc 是一个基于 JSDoc 正文的 API 文档生成工具，能够主动生成 RESTful API 文档，并反对多种格局输入，包含 HTML、Markdown、Swagger 等。
  4. SmartDoc: SmartDoc 是一款 Java RESTful API 文档生成工具，可能主动扫描我的项目中的代码并生成易于浏览和了解的 API 文档。反对多种生成格局，包含 HTML、Markdown、Swagger 等。
  5. Apiary: Apiary 是一个在线的 API 设计和文档治理平台，用户能够应用 API Blueprint 语言编写 API 文档，并提供了交互式 UI 和 API 调试性能。同时，Apiary 还提供了多种集成和合作性能，不便团队协同开发和治理 API。
  6. Postcat 开源的 API 管理工具，目前我正在参加的开源我的项目，纯国产，收费的，主打插件生态，适宜中小团队以及集体开发者应用，有 API 相干的外围性能。

目前在 Github 上 3k star, 如果你感觉这个我的项目还不错的话，无妨点个 star 反对一下~
Github：
https://github.com/Postcatlab/postcat
Demo:
https://postcat.com/zh/?utm_source=sf&utm_campaign=xh&utm_con…

Postcat 外围性能：

  • API 文档治理 ：可视化 API 设计，生成 API 文档
  • API 测试 ：主动生成测试参数，主动生成测试用例，可视化数据编辑
  • 插件拓展 ：泛滥插件扩大产品性能，打造属于你和团队的 API 开发平台
  • Mock：依据文档主动生成 Mock, 或创立自定义 Mock 满足简单场景
  • 团队合作 ：既能实现 API 分享也能能够创立云空间独特合作

Postcat 劣势：

  • 免登录即可测试 ：省去繁琐的验证登录的操作
  • 界面简洁 ：没有冗余的性能与简单选项
  • 收费 ：中小团队以及集体应用
  • 丰盛的插件 ：反对数据迁徙（postman\apifox\apipost）、主题、API 平安等高达 30 款插件
  • 国产 ：能更好的了解国内用户的需要，与开发团队沟通无障碍
  • 欠缺的用户文档 ：跟着操作就能疾速上手

多提 Issue ! 多反馈！

在应用过程中有任何疑难，能够进群交换：也能够在线提 Issue（强烈推荐这种开源的形式），提问题自身就曾经在奉献社区了：
https://github.com/Postcatlab/postcat/issues

退出移动版