Spring Boot 整合 swagger和swagger-ui配置

pom.xml配置依赖


        
            io.springfox
            springfox-swagger2
            2.6.1
        
        
            io.springfox
            springfox-swagger-ui
            2.6.1
        

SwaggerConfig配置

package com.demo.config;

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

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.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

/**
 * Filename: SwaggerConfig
 * Author:   Zhang Wei
 * Date:     2018/8/28 15:02
 * Description:日志配置类
 * History:
 */
@Slf4j
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    
    @Bean
    public Docket createRestApi() {
        ParameterBuilder parameterBuilder = new ParameterBuilder();
        List parameters       = new ArrayList<>();
        parameterBuilder.name("Authorization").description("Authorization")
                .modelRef(new ModelRef("string")).parameterType("header")
                .required(false).build();
        parameters.add(parameterBuilder.build());

        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.demo.controller"))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(parameters)
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("demo")
                .description("模块")
                .version("1.0")
                .build();
    }
}

使用示例

/**
     * 退出登录
     *    @ApiOperation : swagger注解
     * @param userJson
     * @return
     * @throws Exception
     */
    @ApiOperation(value = "退出登录", notes = "param:UserJson")
    @RequestMapping(value = "/logout", method = RequestMethod.POST)
    public Object logout(@RequestBody UserJson userJson) throws Exception{
        if(EmptyUtil.isEmpty(userJson) || EmptyUtil.isEmpty(userJson.getToken())){
            return ResultUtil.error(ExceptionEnum.PARAM_NULL);
        }
        Result result = userService.logout(userJson);
        return result;
    }

你可能感兴趣的:(Spring Boot 整合 swagger和swagger-ui配置)