API管理
所有文档

          API网关

          API管理

          创建API

          1. 点击创建按钮,弹出创建选框 image.png

            image.png

          查看API

          1. 点击左侧导航栏API名称进入"API"信息页面 image.png
          2. 默认进入基础信息页,进行API基础信息的编辑,包括:

            • 名称:名称必须唯一,支持汉字、英文字母、数字、英文格式的下划线和中划线,必须以英文字母或汉字开头,1~32个字符
            • 英文名:英文名称必须唯一,支持英文字母、数字,必须以英文字母开头,1~32个字符
            • 路径:包括method 和 path, 同一服务下必须唯一
            • 标签:可关联已创建标签
            • 描述:支持MarkDown格式的文本描述
          3. 切换Tab进入请求参数页面,包括:

            • Path参数:参数名称、是否必选、类型、描述、示例值
            • Query参数:参数名称、是否必选、类型、描述、示例值
            • Header参数:参数名称、是否必选、类型、描述、示例值
            • Body参数:参数名称、是否必选、类型、描述、示例值

            image.png

            其中Body参数由于比较复杂,支持界面编辑、JsonSchema、导入3种模式

            简单情况建议使用界面编辑:

            image.png

            服务情况推荐使用导入模式:

            image.png

            这两种方式结果上完全等价

          4. 切换Tab进入响应参数页面

            与请求参数操作类似

          5. 切换Tab进入请求示例页面

            允许用户自定义请求示例 image.png

          6. 切换Tab进入响应示例页面

            允许用户自定义响应示例,包括成功示例和失败示例

          7. 切换Tab进入错误码页面

            允许用户自定义错误码 image.png

          8. 右侧支持在线预览,包括:

            image.png

            • 在线文档

            image.png

            • 在线调试:

            image.png

          上一篇
          标签管理