快捷導(dǎo)航

Java詳解swagger2如何配置使用

更新時(shí)間：2022年06月30日 09:08:52 作者：念舊、sunshine

編寫和維護(hù)接口文檔是每個(gè)程序員的職責(zé)，根據(jù)Swagger2可以快速幫助我們編寫最新的API接口文檔，再也不用擔(dān)心開會(huì)前仍忙于整理各種資料了，間接提升了團(tuán)隊(duì)開發(fā)的溝通效率

1、引入jar包

 <!--接口文檔-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.10.5</version>
            <exclusions>
                <exclusion>
                    <groupId>io.swagger</groupId>
                    <artifactId>swagger-annotations</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>io.swagger</groupId>
                    <artifactId>swagger-models</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.springframework.plugin</groupId>
                    <artifactId>spring-plugin-core</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-annotations</artifactId>
            <version>1.6.0</version>
        </dependency>
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-models</artifactId>
            <version>1.6.0</version>
        </dependency>

2、啟用swagger application.properties

不用了

#swagger開關(guān)
swagger.enable=true

3、配置文件

package com.zkhx.config;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
import java.util.ArrayList;
import java.util.List;
@Configuration // 標(biāo)明是配置類
@EnableSwagger2WebMvc 
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfig {
    /**
     * Create rest api docket.
     *
     * @return the docket
     */
    @Bean
    public Docket createRestApi() {
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        //header中的token參數(shù)非必填，傳空也可以
        tokenPar.name("token").description("請(qǐng)求接口所需Token")
                .modelRef(new ModelRef("string")).parameterType("header")
                .required(false).build();
        pars.add(tokenPar.build());
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(metaData())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zkhx.controller"))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars);
    }
    private ApiInfo metaData() {
        return new ApiInfoBuilder()
                .title("XX服務(wù)API文檔")
                .description("sun")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }
}

Docket(DocumentationType.SWAGGER_2) :DocumentationType.SWAGGER_2 固定的，代swagger2
groupName("") // 如果配置多個(gè)文檔的時(shí)候，那么需要配置groupName來分組標(biāo)識(shí)
apiInfo(apiInfo()) // 用于生成API信息
select() // select()函數(shù)返回一個(gè)ApiSelectorBuilder實(shí)例,用來控制接口被swagger做成文檔
apis(RequestHandlerSelectors.basePackage("com.example.controller")) // 用于指定掃描哪個(gè)包下的接口
paths(PathSelectors.any())// 選擇所有的API,如果你想只為部分API生成文檔，可以配置這里
apiInfo() :
title("XX項(xiàng)目API") // 可以用來自定義API的主標(biāo)題
description("XX項(xiàng)目SwaggerAPI管理") // 可以用來描述整體的API
termsOfServiceUrl("") // 用于定義服務(wù)的域名
version("1.0") // 可以用來定義版本。

三級(jí)目錄

@Api(tags = “角色管理”) // tags：你可以當(dāng)作是這個(gè)組的名字。

@RestController

public class RoleController {

}

@RestController
@Slf4j
@RequestMapping("/phm/db")
@Api(tags = "數(shù)據(jù)篩查")
public class DbController {
    @Autowired
    private StatusDbService statusDbService;
    @GetMapping("/field/data")
    @ApiOperation(value = "通過時(shí)間及單元id獲取數(shù)據(jù)篩查所需數(shù)據(jù)")
    public ResultMsg getFieldByUnitIdWithTime( 
    @ApiParam("結(jié)束時(shí)間") @RequestParam(value = "endTime", required = false) @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") Date endTime);
    }

訪問

http://localhost:8080/doc.html

到此這篇關(guān)于Java詳解swagger2如何配置使用的文章就介紹到這了,更多相關(guān)Java swagger內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: