SpringBoot集成Swagger

最新推荐文章于 2024-10-01 18:51:18 发布

guan_xfeng

最新推荐文章于 2024-10-01 18:51:18 发布

阅读量464

点赞数

文章标签： java

本文链接：https://blog.csdn.net/guan_xfeng/article/details/124450870

版权

1.新建一个SpringBoot-web项目

2.导入相关依赖

<!-- springfox-swagger2 -->
<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>

3.编写一个HelloWorld工程

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello(){

        return "hello";
    }
}

4.配置swagger-config

package com.jt.swagger.config;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2 //开启swagger注解
public class SwaggerConfig {

}

5.测试运行

测试路径:http://localhost:8080/swagger-ui.html

6.配置Docket类信息(个性化设置–配置类直接配置Docket类的Bean实例)

package com.jt.swagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

@Configuration
@EnableSwagger2 //开启swagger注解
public class SwaggerConfig {

    /**
     * 配置了swagger的Docket的Bean实例
     * @return
     */
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }


    //配置swagger的Docket的bean实例
    private ApiInfo apiInfo(){

        //作者信息
        Contact DEFAULT_CONTACT = new Contact("3333333333", "222222", "1111111");

        return new ApiInfo(
                "guan_xfeng",
                "afeng",
                "vvvvvvvvvvvv1.0",
                "4900000",
                DEFAULT_CONTACT,
                "Addddddddddd.0",
                "http://www.dddddddddddddddd",
                new ArrayList());
    }
}