接口管理

接口管理用于在线管理项目的RESTFUL API接口文档,通过在线录入结构化的接口信息,生成统一格式的接口文档,并能有效管理接口版本,方便团队内部查阅、更新、分发。

接口库

一个项目下可以建立多个接口库,方便分别管理项目各个子系统的接口文档。

接口版本

一个接口库可以建立多个接口版本,并且至少建立一个初始版本,除下初始版本,建立更多版本时,必须选择父版本。

新建接口库

默认一个项目下不包含任何接口库,我们需要为项目建立一个接口库:

创建接口库

接口库创建成功后,我们就进入了该接口库的查看模式中,在查看模式,我们可以检索、查阅、下载当前的接口文档。

编辑

点击导航栏上的“编辑”按钮,将进入文档的编辑模式,在编辑模式用于编辑更新文档库的简介、对象、接口、分组等等信息。

编辑API接口

简介

文档简介用于描述该接口文档,一个文档允许增加多个简介,生成文档后,每一个简介都对应一个带有标题的段落。

对象

对象是指接口中引用的数据结构,每一个对象拥有多个字段,字段拥有字段名、类型、简介等设置。

元组

元组是另外一种数据结构,类似数组,元组长度固定,元组内每一个元素都拥有类型、简介等设置。

接口

接口是指一个拥有一个特定访问地址和请求方法的HTTP接口,我们可以设置一个接口的请求参数、返回结果等信息。

分组

分组用于给接口分组,可以建立多个接口分组,接口必须隶属于一个分组。

错误码

错误码可以用来管理系统中所可能的错误信息,方便查阅文档。

发布版本

接口管理的每一个版本都可以进行发布操作,版本发布之后就不再允许编辑,如果需要编辑,那么应该建立一个新版本,在新版本之上进行编辑。

results matching ""

    No results matching ""