LeAPI - 使用 oneapi 插件自动生成前端请求代码

一、OpenAPI 规范

参考官方文档:OpenAPI 规范 (中文版) (apifox.cn)

1. 由 Swagger 规范重命名而来,定义了后端接口的规范

2. 遵循 RESTful API 的规范,让使用 API 的开发人员轻松理解该 API

3. 遵循 OpenAPI 规范的好处

  • 可以用文档生成工具来展示 API
  • 用代码生成工具来自动生成各种编程语言的服务器端和客户端的代码
  • 用自动测试工具进行测试等等

4. 使用背景:已有后端接口(遵循 OpenAPI 规范),则可使用 oneapi 插件自动生成前端请求后端接口的代码和请求参数封装对象

二、详细使用步骤

1. 查看并复制 Knife4j 接口文档地址:分组 Url

LeAPI - 使用 oneapi 插件自动生成前端请求代码_第1张图片

LeAPI - 使用 oneapi 插件自动生成前端请求代码_第2张图片

2. 在前端项目 config.ts 配置接口地址(此处使用 Ant Design Pro 支持的 oneapi 插件)

http://localhost:8101/api/v2/api-docs

LeAPI - 使用 oneapi 插件自动生成前端请求代码_第3张图片

3. 在项目的 package.json 运行脚本,自动生成请求代码

LeAPI - 使用 oneapi 插件自动生成前端请求代码_第4张图片

4. 查看自动生成的请求代码和请求参数封装类型(与后端接口封装的 DTO / VO 对应)

LeAPI - 使用 oneapi 插件自动生成前端请求代码_第5张图片

LeAPI - 使用 oneapi 插件自动生成前端请求代码_第6张图片

你可能感兴趣的:(LeAPI,-,前端,前端,oneapi)