spring boot項目添加swagger 2.7.0(只需兩步操作)


1.pom.xml引入swagger 2.7的jar包

        <!-- swagger2 rest api start-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>
        <!-- swagger2 rest api end-->

2.SwaggerConfig.class(放在可以被spring掃碼到的地方)

import org.springframework.boot.context.properties.ConfigurationProperties;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author TangZedong
 * @apiNote swagger2配置文件
 * @since 2018/9/4 10:46
 */
@Configuration
@EnableSwagger2
@ConfigurationProperties
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .forCodeGeneration(true)
.groupName("指定group的名稱,groupName不能重復") .select() .apis(RequestHandlerSelectors.basePackage(
"這里是你需要掃描的包路徑")) //過濾生成鏈接 .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()); } /** * the api info * * @return api info */ private ApiInfo apiInfo() { return new ApiInfoBuilder() .license("Apache License Version 2.0") .title("blogspot") .description("api docs") .contact(new Contact("tangzedong", "https://www.cnblogs.com/HackerBlog/", "tangzedong.programmer@gmail.com")) .version("1.0") .build(); } }

然后所有的操作就完成了,是不是很簡單?就是這么簡單

然后啟動spring boot服務器,在網頁上輸入網址:http://localhost:8080/swagger-ui.html 你就可以看見swagger的頁面了

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM