环境:Spring Boot,Swagger,gradle,Postman,newman,jenkins
SpringBoot环境搭建。
Swagger简介
Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。
一、SpringBoot集成Swagger
1.build.gradle增加swagger相关jar包,maven项目同理。
2.增加SwaggerConfig配置文件。
前两步完成,访问http://localhost:8080/demoService/swagger-ui.html#/即可看见swagger的api页面了。下面几个步骤是为了解决一些配置问题,没有以下几种问题可以不用配置。
package com.example.demo;
import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
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;
@Configuration
@EnableSwagger2
@ConditionalOnExpression("${swagger.enable:true}")
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
ParameterBuilder sessionIdPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<Parameter>();
sessionIdPar.name("SESSIONID").description("用户 sessionid")
.modelRef(new ModelRef("string")).parameterType("header")
.required(true).build();
pars.add(sessionIdPar.build()); //根据每个方法名也知道当前方法在设置什么参数
return new Docket(DocumentationType.SWAGGER_2)
.globalOperationParameters(pars)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.demo"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("springboot利