快速搭建spring boot 的 Swagger

简介: 快速搭建spring boot 的 Swagger

快速搭建一个Swagger

1、新建一个maven

2、导入依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <artifactId>spring-boot-starter-parent</artifactId>
        <groupId>org.springframework.boot</groupId>
        <version>2.6.0</version>
        <relativePath/>
    </parent>
    <groupId>org.swaggerTest</groupId>
    <artifactId>swaggerTest</artifactId>
    <version>1.0-SNAPSHOT</version>
    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>
    <dependencies>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

3、新建Application

package com.rw;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
 * @author yl
 * @createDate 2022/5/25
 * @description
 */
@SpringBootApplication
public class rwApplication {
    public static void main(String[] args) {
        SpringApplication.run(rwApplication.class,args);
    }
}

4、新建一个application.yml文件

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

5、新建一个配置文件SwaggerConfig

package com.rw.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
/**
 * @author yl
 * @createDate 2022/5/25
 * @description
 *
 * 访问地址 :http://127.0.0.1:8080/swagger-ui/index.html
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.rw"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo(){
        Contact DEFAULT_CONTACT = new Contact("yl", "www.baidu.com", "12345@qq.com");
        return new ApiInfo(
                "StudySwagger",
                "YL",
                "1.0",
                "urn:tos",
                DEFAULT_CONTACT,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList<>());
    }
}

6、运行项目

 

相关文章
|
3月前
|
Java API Spring
Swagger使用-Spring Boot整合Swagger
Swagger使用-Spring Boot整合Swagger
45 0
|
3月前
|
前端开发 Java 开发者
Spring Boot 3 集成 Thymeleaf
Thymeleaf是一款用于Web和独立环境的现代化服务器端Java模板引擎。它能够处理HTML、XML、JavaScript、CSS甚至纯文本。Thymeleaf的语法简单易懂,它允许开发者在模板中嵌入表达式,以便动态地渲染数据。
77 1
Spring Boot 3 集成 Thymeleaf
|
1月前
|
Java Spring
Spring Boot3整合knife4j(swagger3)
Spring Boot3整合knife4j(swagger3)
191 1
|
数据可视化 JavaScript 前端开发
Spring Boot集成Swagger2
你好看官,里面请!今天笔者讲的是Spring Boot集成Swagger2。不懂或者觉得我写的有问题可以在评论区留言,我看到会及时回复。 注意:本文仅用于学习参考,不可用于商业用途,如需转载请跟我联系。
200 1
|
数据可视化 Java API
【Spring Boot 快速入门】五、Spring Boot集成Swagger UI
【Spring Boot 快速入门】五、Spring Boot集成Swagger UI
1078 0
【Spring Boot 快速入门】五、Spring Boot集成Swagger UI
|
XML 监控 Java
Spring Boot的讲解以及通过Maven构建Spring Boot应用及快速构建Spring Boot(附源码 超详细)
Spring Boot的讲解以及通过Maven构建Spring Boot应用及快速构建Spring Boot(附源码 超详细)
214 0
Spring Boot的讲解以及通过Maven构建Spring Boot应用及快速构建Spring Boot(附源码 超详细)
|
SQL Java 关系型数据库
【Spring Boot 快速入门】九、Spring Boot集成MyBatis-Plus
【Spring Boot 快速入门】九、Spring Boot集成MyBatis-Plus
251 0
|
安全 Java 开发者
【Spring Boot 快速入门】六、Spring Boot集成Lombok
【Spring Boot 快速入门】六、Spring Boot集成Lombok
131 0
【Spring Boot 快速入门】六、Spring Boot集成Lombok
|
Java 测试技术 Maven
【Spring Boot 快速入门】四、Spring Boot集成JUnit
【Spring Boot 快速入门】四、Spring Boot集成JUnit
226 0
【Spring Boot 快速入门】四、Spring Boot集成JUnit
|
监控 前端开发 Java
简化Swagger使用的自制Starter:spring-boot-starter-swagger,欢迎使用和吐槽
简化Swagger使用的自制Starter:spring-boot-starter-swagger,欢迎使用和吐槽
205 0

热门文章

最新文章