纯净、安全、绿色的下载网站

首页|软件分类|下载排行|最新软件|IT学院

当前位置:首页IT学院IT技术

Springboot集成swagger Springboot集成swagger实现方式

Shaun_code   2021-08-31 我要评论
想了解Springboot集成swagger实现方式的相关内容吗,Shaun_code在本文为您仔细讲解Springboot集成swagger的相关知识和一些Code实例,欢迎阅读和指正,我们先划重点:Springboot集成swagger,Springboot集成,下面大家一起来学习吧。

Swagger 提供了一个全新的维护 API 文档的方式,有4大优点:

  • 自动生成文档:只需要少量的注解,Swagger 就可以根据代码自动生成 API 文档,很好的保证了文档的时效性。
  • 跨语言性,支持 40 多种语言。
  • Swagger UI 呈现出来的是一份可交互式的 API 文档,我们可以直接在文档页面尝试 API 的调用,省去了准备复杂的调用参数的过程。
  • 还可以将文档规范导入相关的工具(例如 SoapUI), 这些工具将会为我们自动地创建自动化测试。

如何实现swagger

一: pom文件加入依赖包

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

二:修改配置文件

1.application.properties 加入配置

#表示是否开启 Swagger,一般线上环境是关闭的
spring.swagger2.enabled=true

2.增加一个swagger配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Value(value = "${spring.swagger2.enabled}")
    private Boolean swaggerEnabled;
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(swaggerEnabled)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.swagger.boot"))//包名代表需要生成接口文档的目录包。
                .paths(PathSelectors.any())
                .build();
    }
     private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口文档")
                .description(" Spring Boot")
                .version("1.0")
                .build();
    }
}

相关文章

猜您喜欢

  • Python火车站售票 Python多线程实现模拟火车站售票

    想了解Python多线程实现模拟火车站售票的相关内容吗,程序员攻略在本文为您仔细讲解Python火车站售票的相关知识和一些Code实例,欢迎阅读和指正,我们先划重点:python火车站售票,Python多线程火车站售票,Python售票,下面大家一起来学习吧。..
  • Python函数 Python函数基础

    想了解Python函数基础的相关内容吗,士别三日wyx在本文为您仔细讲解Python函数的相关知识和一些Code实例,欢迎阅读和指正,我们先划重点:Python函数,下面大家一起来学习吧。..

网友评论

Copyright 2020 www.cosoft.cc 【酷软网】 版权所有 软件发布

声明:所有软件和文章来自软件开发商或者作者 如有异议 请与本站联系 点此查看联系方式