接口文档:

详细地描述了后端接口的访问方式和参数说明

接口定义方式主要有两种:

推荐阅读:

https://swagger.io/
https://swagger.io/tools/open-source/

swagger:

history

  • SmartBear Software
  • RESTFUL API工具
  • 设计,构建,记录,使用
  • openAPI Initiative

uses

  • 项目中接口展现
  • 接口更新
  • 直接接口调用

目前团队使用的API-Management工具——YAPI

EasyYapi - 可以导出http,rpc,call api 调用 API

apimock

swaggerconfig配置类集成到 api-mock组件中,swagger生成的接口文件可以通过数据导入,导入到yapi中

其他