swagger3的安装与使用

本文档详细介绍了Swagger3在SpringBoot项目中的安装步骤,包括添加依赖、配置调整、创建配置类和启动测试。同时,讨论了Swagger的使用,特别是在实体类和Controller类中的Swagger注解应用,帮助提升接口文档的编写效率,实现前后端高效协作。
摘要由CSDN通过智能技术生成

Swagger是一个开源的软件框架,可以帮助开发人员设计、构建和使用Web服务,将代码与文档结合在一起,完美的解决了前后端分离的接口交接问题(编写接口文档,方便前后端交互),使开发人员将大部分精力集中到业务中,而不是文档的撰写,提高了开发效率也减少了开发成本。swagger官网

一、Swagger的安装

1、添加依赖
        <!--swagger依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
        <!--swagger第三方插件-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>
2、添加配置

:Springfox使用的路径匹配是基于AntPathMatcher的,而Spring Boot 2.6.X使用的是PathPatternMatcher

spring:
  mvc:
    pathmatch:
      # 解决swagger3和springboot版本冲突
      matching-strategy: ant_path_matcher

# 用来开启或关闭文档的显示,线上不需要开启,开启会浪费资源
springfox:
  documentation:
    swagger-ui:
      enabled: true
3、创建配置类
package com.chen.config;

import org.springfr
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值