1. 产品简介
  2. 快速开始
  3. 编写构建流程
  4. 配置构建计划
  5. 构建环境依赖包
  6. 构建制品
  7. 构建节点
  8. 管理构建计划
  9. 系统插件
  10. 自定义团队插件
  11. 最佳实践
  12. 常见问题
  13. 词汇表
文档管理 / 编写与导入 / apiDoc

apiDoc

apiDoc 是一款通过注释或注解生成 API 文档的工具,支持 Java、PHP、JS 等多种语言,生成方便,但文档体验较差。您可通过将生成文档中间文件 api_data.json 导入至「CODING API 文档」,生成精美的 API 文档。

获得 apiDoc API 数据文件

如图所示为 apiDoc 示例文档,通过 apiDoc 生成的 API 文档同理。

将地址栏中地址最后加上 api_data.json,即 http://apidocjs.com/example/api_data.json 即为 API 数据文件地址。

通过 URL 导入

如图所示,在【发布新版本】页或者【录入 API 数据页】,选择【导入数据】下的【从 URL 导入】,粘贴刚才复制的 API 数据文件地址,最后选择【完成并发布】实现文档发布。

通过上传文件导入

在网页上右键点击弹出菜单,选择 存储为 将 API 数据文件保存至本地。

在【发布新版本】页或者【录入 API 数据页】,选择【导入数据】下的【从文件导入】,导入刚才存到本地的api_data.json文件,最后选择【完成并发布】实现文档发布。

问题反馈 >
上一篇Postman
2022-05-07最近更新
感谢反馈有用
感谢反馈没用

在阅读中是否遇到以下问题?*

您希望我们如何改进?*

在线支持

工单咨询