Version: 当前版本

API文档管理

1. 背景与说明#

前后端联调时，通常需要后端给出文档以详细说明接口的输入输出；

后端开发完成后，需要测试接入网关是否成功。

为了减少割裂感、提升前后端开发的用户体验，需要在shenyu-admin中看到API文档，以及直接对API进行测试。

2. 使用流程#

大体的流程如下：

后端开发在shenyu-admin中产出API文档。
已经支持远程拉取swagger、手动填写、客户端注册3种方式。从功能完整性和使用体验上，目前更推荐远程拉取swagger，后2种方式将会在后面版本持续功能增强。
前端在shenyu-admin中查看API文档并开始开发。
联调期间开发人员(包括前后端)可以直接使用shenyu-admin中的接口调试功能发起API调用。

3. 设置全局的环境地址#

实际使用中，可能你有多个网关地址（比如生产环境、测试环境，或者公网环境、内网环境），你可以在Apache ShenYu网关管理系统 --> 基础配置 --> 字典管理，配置多个网关地址。

apidoc-env-cn

字典类型：填写值必须是apidocEnv；
字典编码：网关地址的编码标识，无实际含义，建议以 ENV_LABEL_作为前缀，比如 ENV_LABEL_OFFLINE；
字典名称：表示网关类型，比如填写 测试环境、生产环境。该值将会出现在API文档详情页面；
字典值：表示网关地址，比如 http://127.0.0.1:9195。该值将会出现在API文档详情页面；
字典描述或备注：该网关地址用于何种场景，做一个简短描述。该值将会出现在API文档详情页面；
排序：数值大小决定了网关地址的展示顺序；
状态：打开或关闭。