java接口设计文档 实例_Java后端开发——Swagger接口文档代码示例

packagecom.xolo.core.config;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;importspringfox.documentation.builders.ApiInfoBuilder;importspringfox.documentation.builders.ParameterBuilder;importspringfox.documentation.builders.PathSelectors;importspringfox.documentation.builders.RequestHandlerSelectors;importspringfox.documentation.schema.ModelRef;import springfox.documentation.service.*;importspringfox.documentation.spi.DocumentationType;importspringfox.documentation.spring.web.plugins.Docket;importspringfox.documentation.swagger2.annotations.EnableSwagger2;importjavax.servlet.http.HttpServletRequest;importjavax.servlet.http.HttpServletResponse;importjava.util.ArrayList;importjava.util.List;

@Configuration

@EnableSwagger2public classSwaggerConfig {

@BeanpublicDocket createRestApi() {

ParameterBuilder param= newParameterBuilder();

List params = new ArrayList<>();

param.name("Authorization").description("用户登录令牌")

.modelRef(new ModelRef("string")).parameterType("header")

.required(true).build();

params.add(param.build());return newDocket(DocumentationType.SWAGGER_2)

.select()

.apis(RequestHandlerSelectors.basePackage("com.xolo.core.controller"))

.paths(PathSelectors.any())

.build()

.globalOperationParameters(params)

.ignoredParameterTypes(HttpServletResponse.class, HttpServletRequest.class)

.apiInfo(newApiInfoBuilder()

.title("页面头")

.description("页面描述")

.contact(new Contact("创建人姓名", "阅读更多信息的页面地址", "联系邮箱地址"))

.version("版本号")

.build()

);

}

}