springboot集成Swagger

本文介绍了如何在SpringBoot项目中集成Swagger,包括Swagger的基本概念、配置步骤、拓展应用以及如何自定义swagger的皮肤,提供了从引入依赖到配置生效的详细过程,并探讨了在不同环境下关闭或开启Swagger的方法。
摘要由CSDN通过智能技术生成

初识Swagger

  • 号称世界上最流行的API框架

  • Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新

  • 直接运行,在线测试API

  • 支持多种语言 (如:Java,PHP等)

  • 官网:https://swagger.io/

Swagger作为一个框架,我们需要引入第三方jar包,并且在springboot中进行配置,才可以基于他们的语法来使用他们的功能

配置

引入依赖

  • swagger2:swagger2的功能包

  • swagger-ui:swagger的可视化界面

<!-- swaggerUI -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
<!-- swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

开启配置

  • 配置swagger,需要新建一个配置类,并且为这个配置类用@EnableSwagger2注解开启swagger自动配置。
@Configuration
@EnableSwagger2
public class SwaggerConfig {
   
}

注册分组

  • Swagger实例Bean是Docket,所以通过配置Docket实例来配置Swaggger。
@Bean
public Docket docket(){
   
    return new Docket(DocumentationType.SWAGGER_2).groupName("分组一"
  • 2
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值