J2PaaS接口模块管理与接口文档的使用

2021-08-31 14:49

3 0 0

前言:

J2PaaS开源在即,对API的开发效率提升做出一系列整改,将零散的接口整合在一个个的模块下,并创建接口文档 UI 页,方便前后端开发人员的交接。

1、维护接口模块

在开发工具中,打开菜单栏,选择 API -> API模块,进入API模块维护界面

模块结构页:

  • 查看当前已维护及未维护的接口,以树结构展示
  • 模糊搜索API或模块信息
  • 双击进入对应API参数页

 

模块管理页:

  • 新增、修改、删除模块,模块信息在表 api_module 中存储
  • 将选择后的接口放到模块下,操作方式类似菜单管理
  • 一个接口属于一个模块,一个模块存有多个接口
  • 接口已存入模块,可选接口处将不会再看到该接口
  • 模块可属于另一个模块,但最多支持一层子模块(即不存在孙子辈模块)
  • 模糊搜索模块信息

 

2、接口文档查看

在模块结构页,点击接口文档按钮,进入接口文档页面。或输入网址:“http://xxxx/apifox?app=项目id”,前端开发员可通过该地址访问接口文档

接口文档页:

  • 仿 Swagger UI 设计,使用方式也类似
  • 非匿名访问需要提供 API 账号密码以及机构号获得授权

 

还可以输入500个字
表情
Ctrl+Enter
全部评论(0)
最新/最热

沈润星

福建省 | 漳州市

关注
私信
技巧分享
写私信×
沈润星
还可以输入500个字