java的api文档_Java Api 文档

Swagger2

io.springfox

springfox-swagger2

2.9.2

io.springfox

springfox-swagger-ui

2.9.2

常用注解

@Api：controller类注解

@ApiOperation：controller类中方法注解

@ApiIgnore：忽略

@ApiParam：请求属性设置

配置注入

@Configuration

@EnableSwagger2

public class Swagger2Config {

@Bean

public Docket createRestApi() {

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select()

.apis(RequestHandlerSelectors.basePackage("com")) //要扫描的包名

.paths(PathSelectors.any()) //过滤路径

.build();

}

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title("Restful Api | 文档构建")

.description("更多Spring Boot相关文章请关注：http://www.xxx.com/")

.termsOfServiceUrl("http://www.xxx.com/")

.contact(new Contact("abc", "http://www.xxx.com/", "abc@163.com"))

.version("1.0")

.build();

}

}

通过.groupName("")可以设置分组，每个分组对应一个Docket实例，相关参见

knife4j

com.github.xiaoymin

knife4j-spring-boot-starter

2.0.4