Spring boot配置 swagger的示例代码

 更新时间:2021年09月18日 17:14:25   作者:XiaoRunStar  
Swagger是一组开源项目,Spring 基于swagger规范,可以将基于SpringMVC和Spring Boot项目的项目代码,自动生成JSON格式的描述文件,接下来通过本文给大家介绍Spring boot配置 swagger的示例代码,一起看看吧

为什么使用Swagger

    在实际开发中我们作为后端总是给前端或者其他系统提供接口,每次写完代码之后不可避免的都需要去写接口文档,首先写接口文档是一件繁琐的事,其次由接口到接口文档需要对字段、甚至是排版等。再加上如果我们是为多个系统提供接口时可能还需要按照不同系统的要求去书写文档,那么有没有一种方式让我们在开发阶段就给前端提供好接口文档,甚至我们可以把生成好的接口文档暴露出去供其他系统调用,那么这样我只需要一份代码即可。

Spring boot配置 swagger

 1.导入maven依赖

<!--配置swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>

        <!--swagger第三方ui-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

2.swagger配置类

@EnableSwagger2                // Swagger的开关,表示已经启用Swagger
@Configuration                 // 声明当前配置类
public class SwaggerConfiguration  {

    @Value("${swagger.basePackage}")
    private String basePackage;       // controller接口所在的包

    @Value("${swagger.title}")
    private String title;           // 当前文档的标题

    @Value("${swagger.description}")
    private String description;         // 当前文档的详细描述

    @Value("${swagger.version}")
    private String version;         // 当前文档的版本



    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(title)
                .description(description)
                .version(version)
                .build();
    }

}

3.application.yml

# 配置swagger
swagger:
  basePackage: com.xx.demo.controller #包名
  title: 标题  #标题
  description: 项目文档 #描述
  version: V1.0  #版本号

4.在controller里使用

@Api(tags = {"测试类"})
@RestController
@RequestMapping("/test")
public class TestController {
    @ApiOperation(value = "测试方法")
    @GetMapping("/xrx")
    public String xrx() {
        return "hello";
    }
}

5.访问swagger

http://localhost:8080/swagger-ui.html
http://localhost:8080/doc.html

在这里插入图片描述

到此这篇关于Spring boot配置 swagger的示例代码的文章就介绍到这了,更多相关Spring boot配置 swagger内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java实现普通类注入service对象

    Java实现普通类注入service对象

    这篇文章主要介绍了Java实现普通类注入service对象,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • jdk在centos中安装配置图文教程

    jdk在centos中安装配置图文教程

    这篇文章主要介绍了jdk在centos中安装配置图文教程,文中给出大家jdk下载地址,需要的朋友可以参考下
    2018-04-04
  • java把excel内容上传到mysql实例代码

    java把excel内容上传到mysql实例代码

    这篇文章主要介绍了java把excel内容上传到mysql实例代码,具有一定借鉴价值,需要的朋友可以参考下
    2018-01-01
  • SpringBoot项目中如何访问HTML页面

    SpringBoot项目中如何访问HTML页面

    这篇文章主要介绍了SpringBoot项目中如何访问HTML页面,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • java中的常见关键字解析

    java中的常见关键字解析

    这篇文章主要介绍了java中的常见关键字,需要的朋友可以参考下
    2014-08-08
  • 一步步教你JAVA如何优化Elastic Search

    一步步教你JAVA如何优化Elastic Search

    想要榨干Java操作Elasticsearch的所有性能潜力?本指南将一步步教你如何优化Java与Elasticsearch的交互!从此,提升ES查询速度、降低资源消耗不再是难题,赶快一起来探索Java Elasticsearch优化的秘诀吧!
    2024-01-01
  • 关于Future机制原理及解析

    关于Future机制原理及解析

    这篇文章主要介绍了关于Future机制原理,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-11-11
  • 解决myBatis generator逆向生成没有根据主键的select,update和delete问题

    解决myBatis generator逆向生成没有根据主键的select,update和delete问题

    这篇文章主要介绍了解决myBatis generator逆向生成没有根据主键的select,update和delete问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-09-09
  • SpringBoot实现PDF添加水印的示例

    SpringBoot实现PDF添加水印的示例

    本文主要介绍了SpringBoot实现PDF添加水印的示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-05-05
  • 使用Spring Boot如何限制在一分钟内某个IP只能访问10次

    使用Spring Boot如何限制在一分钟内某个IP只能访问10次

    有些时候,为了防止我们上线的网站被攻击,或者被刷取流量,我们会对某一个ip进行限制处理,这篇文章,我们将通过Spring Boot编写一个小案例,来实现在一分钟内同一个IP只能访问10次,感兴趣的朋友一起看看吧
    2023-10-10

最新评论