springboot2自动生成接口文档,swagger3的使用

本文介绍了如何在SpringBoot2项目中使用Swagger3来自动生成接口文档。Swagger是一个基于OpenAPI规范的工具,包括Swagger Editor、Swagger UI和Swagger Codegen。文章详细讲述了从添加pom依赖、配置application.properties,到创建配置类的步骤。针对SpringBoot2.6.0以上版本可能出现的问题,给出了解决方案。最后,通过在API和接口上添加注解,展示了如何生成接口文档。
摘要由CSDN通过智能技术生成

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文件依赖

  • <dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-boot-starter</artifactId>
          <version>3.0.0</version>
    </dependency>

    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 

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值