Dataway 整合 Swagger2,让 API 管理更顺畅
发布: · 更新: · 阅读需 3 分钟
Dataway 可以把已发布且启用的接口生成为 Swagger 2.0 文档,Swagger UI 加载文档后便能展示参数并发起请求。本文让一个消息接口在控制台发布后,直接进入 Swagger UI 调试。
Dataway 可以把已发布且启用的接口生成为 Swagger 2.0 文档,Swagger UI 加载文档后便能展示参数并发起请求。本文让一个消息接口在控制台发布后,直接进入 Swagger UI 调试。
应用已经约定 ok、code、message、data 四个响应字段时,可以用 Structure 结果处理器配置同样的结构。本文让成功和脚本失败共用一份模板,并说明直接返回原始值的方式。
分页接口需要同时返回当前页记录和总数。本文使用 SQL 执行器完成数据库分页,接收从 1 开始的 page 和每页数量 size,并将两部分数据组成一个响应。
前端传入人员名称,接口返回匹配人员的编号和姓名。本文明确请求与响应的字段约定,再把 JSON 请求参数绑定到 SQL,最后转换为前端约定的结果结构。
查询类接口通常需要接收参数、执行 SQL 和返回 JSON。Dataway 把这些步骤放入可编辑、可调试、可发布的脚本中;应用负责提供数据源和身份识别。本文以人员查询为例,完成从 Spring 配置到 HTTP 调用的过程。