springboot整合新版swagger(springfox 3.0.0版本)

最新推荐文章于 2024-08-20 17:25:50 发布

小杆子314

最新推荐文章于 2024-08-20 17:25:50 发布

阅读量4.2k

点赞数 3

分类专栏： springboot 工具库文章标签： spring boot

本文链接：https://blog.csdn.net/shaoming314/article/details/112881289

版权

springboot 同时被 2 个专栏收录

161 篇文章 9 订阅

订阅专栏

工具库

38 篇文章 0 订阅

订阅专栏

springboot整合新版swagger(springfox 3.0.0版本)

参考网址:

https://mp.weixin.qq.com/s/zxgSzME4gdvXo9FKSGaMfg

springboot整合旧版swagger的参考网址

http://www.shaoming.club/archives/springboot%E6%95%B4%E5%90%88swaggermd

https://blog.csdn.net/shaoming314/article/details/109197986

前言

之前项目中整合Swagger都是直接通过依赖springfox-swagger、springfox-swagger-ui两个jar包来实现的，最近发现springfox 3.0.0版本已经有了自己的SpringBoot Starter，使用起来更契合SpringBoot项目，非常方便，推荐给大家！

整合步骤

1.引入依赖

pom.xml

<!--springfox swagger官方Starter-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

2.编写配置类

package com.example.demo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * Swagger2API文档的配置
 * 访问地址
 * http://localhost:端口号/swagger-ui/
 * 我搭建项目喜欢使用springboot默认端口8080
 * http://localhost:8080/swagger-ui/
 */
@Configuration
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                /**
                 * 重点说明:
                 * 其余都是可以默认,但是controller扫描的路径一定要该队,是该项目的controller包路径
                 */
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                /**
                 * 指定项目的名称和主题
                 */
                .title("mybatis-plus演示")
                /**
                 * 描述项目的用途
                 */
                .description("复习swagger+mybatis-plus")
                /**
                 * name:使用者的姓名
                 * url:使用者的相关技术文章
                 * email:使用者的邮箱地址
                 */
                .contact(new Contact("shaoming", "http://www.shaoming.club", "1025378286@qq.com"))
                .version("1.0")
                .build();
    }
}