Swagger介绍

基于 OpenAPI 规范(OpenAPI Specification,OAS)构建的开源接口文档自动生成工具,可以让开发人员快速设计、构建、记录以及使用 Rest API

Swagger 主要包含了以下三个部分:

Swagger Editor:基于浏览器的编辑器,我们可以使用它编写我们 OpenAPI 规范。

Swagger UI:它会将我们编写的 OpenAPI 规范呈现为交互式的 API 文档,后文我将使用浏览器来查看并且操作我们的 Rest API。

Swagger Codegen:它可以通过为 OpenAPI(以前称为 Swagger)规范定义的任何 API 生成服务器存根和客户端 SDK 来简化构建过程。

使用介绍

1.SpringBoot添加pom文件依赖

io.springfox

springfox-boot-starter

3.0.0

2.application.properties 配置文件增加配置

#1024shop 是项目名

spring.application.name=1024shop

# ===== 自定义swagger配置 ===== #

swagger.enable=true

swagger.application-name= ${spring.application.name}

swagger.application-version=1.0

#swagger.application-description=1024shop电商平台管理后端接口文档

swagger.application-description=1024shop api info

好文链接

评论可见,请评论后查看内容,谢谢!!!
 您阅读本篇文章共花了: