前后端联调时,通常需要后端给出文档以详细说明接口的输入输出;
后端开发完成后,需要测试接入网关是否成功。
为了减少割裂感、提升前后端开发的用户体验,需要在shenyu-admin中看到API文档,以及直接对API进行测试。
大体的流程如下:
手动填写
和客户端注册
2种方式,目前更推荐客户端注册
)。联调期间开发人员(包括前后端)可能使用shenyu-admin中的测试功能直接请求API。
接下来我们看下具体操作:
在点击菜单 “文档 -> API文档” 展示的页面中新增数据。
通过客户端注册API文档请参考客户端注册API文档
标签用于给API文档分类,标签下面既可以挂API,也可以挂标签,没有层级限制。
这里出现列表的就是我们正在新增的API文档。
如果该API是从未发布到发布且用户并未接入shenyu客户端,shenyu-admin将会自动把API文档所描述的API暴露到网关。
特别注意:点击下线后,API文档仍然可见,但暴露到网关的接口将会立即失效。