开放 API 与 Webhook
  1. 个人访问令牌
  2. WebHook
文件管理与 Wiki
  1. 项目文件管理
  2. 项目 Wiki

API 文档管理

产品功能介绍

API(Application Programming Interface),又称为应用编程接口,是软件系统不同组成部分衔接的约定。软件开发的过程中,通常会有不同的分工和职责,如后端接口开发与 APP 开发工作。其主要目的是为了让开发人员间达成一定的约定,而无需考虑其底层的源代码或内部实现细节。API 本身是抽象的,它仅定义了一个接口,而不涉及应用程序在实际实现过程中的具体操作。

CODING 所提供的 API 文档管理是一个非常强大的工具,它可以帮助您引领 API 的发展和成熟,为开发人员提供出色的交互体验,并允许使用 OpenAPI、Postman、Apidoc 描述格式集成至现有的 CICD 工作流中,从而实现自动化发布流程。此文将帮助您快速熟悉 CODING API 文档管理的基本使用操作。

创建 API 文档

  1. 在【项目】->【API 文档】中点击【发布 API 文档】按钮。

  1. 在配置基础信息页,选择【权限】(私有/公开模式),输入【API 文档访问地址】,选择【API 文档访问模式】,填写【API 文档标题】及【API 文档描述规范】。

私有模式:访问 API 文档需要登录 CODING 企业账号且拥有当前项目 API 文档功能查看权限,或通过分享口令登录查看。

公开模式:访问 API 文档时无需登录,可直接进行查看。

  1. 在录入 API 数据页,选择【导入数据】或【使用默认 Demo 数据】后点击【完成并发布】按钮。

分享 API 文档

  1. 在 API 文档详情页点击【添加分享对象】按钮,填写【分享对象名称】,随机生成/手动填写【访问口令】,选择【口令有效期】完成分享对象新增。

  1. 点击分享对象末端【编辑】按钮,选中【复制链接与口令】,分享链接与口令将复制在粘贴板中。

  1. 发送链接与口令至对应分享对象,分享对象可通过此链接访问 API 文档。

分享对象访问 API 文档

  1. 分享对象通过分享链接进入 API 文档登录页后输入【访问口令】。

  1. 文档中 DESCRIPTION 部分展示了 API 文档的基础信息;API REFERENCE 部分为各个 API 对应的调用说明(请求路由、请求参数、响应参数等),且在右侧提供请求和响应的范例 Demo,方便开发人员进行查看。

文档是否对您有用?
感谢反馈有用
感谢反馈没用