集成使用swagger

swagger,丝袜哥是用来做请求接口的文档化,及测试。

通用设置会在项目中生成一个doc.html。做为一个管理工具由开发者访问,也可以供其它对接人员使用。

常见注解

pom文件接入

		
		2.9.2
		1.9.4
        
		
			io.springfox
			springfox-swagger2
			${swagger.version}
		
		
			com.github.xiaoymin
			swagger-bootstrap-ui
			${swagger-bootstrap-ui.version}
		

SpringBoot项目启动类上添加

@EnableSwagger2

接口方法处添加

@ApiOperation(value = "app-查看支付流水")
@ApiResponses({
        @ApiResponse(code = 200, message = "查看支付流水", response = FirstBannerDto.class)
})

创建配置类:

/**
 * @author cai
 */
@Configuration
public class SwaggerConfig {

    // 

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()                     
             .apis(RequestHandlerSelectors.basePackage("com.kaifa.bussiness.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("开发接口文档")
                .description("xt API 接口文档")
                .termsOfServiceUrl("http://127.0.0.1:8822/doc.html")
                .contact("[email protected]")
                .version("1.0.0")
                .build();
    }

}

启动后访问:

访问 :server的端口/doc.html

你可能感兴趣的:(Java,swagger,java)