千家信息网

Springboot中swagger和knife如何使用

发表于:2025-02-02 作者:千家信息网编辑
千家信息网最后更新 2025年02月02日,Springboot中swagger和knife如何使用,很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。swagger2依
千家信息网最后更新 2025年02月02日Springboot中swagger和knife如何使用

Springboot中swagger和knife如何使用,很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。

swagger2

依赖包

compile group: 'io.springfox', name: 'springfox-swagger2', version: '2.9.2'
compile group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.9.2'
//下面这两包是为了防止注解没有给默认值的时候抛出的警告日志
compile group: 'io.swagger', name: 'swagger-annotations', version: '1.5.22'
compile group: 'io.swagger', name: 'swagger-models', version: '1.5.22'

配置

@Getter
@Setter
@Configuration
@EnableSwagger2
@ConfigurationProperties("swagger")
public class SwaggerConfig {

private String host;//自定义host

@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.only.oc.web.api"))//扫描包
.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))//扫描在API注解的contorller
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))//扫描带ApiOperation注解的方法
.paths(PathSelectors.any())
.build().host(host);//自定义host
}

private ApiInfo apiInfo() {
String version = DateUtil.customFormat(new Date(),"yyyyMMdd.HHmmss");
return new ApiInfoBuilder()
.title("昂立课堂(业务版)")
.description("昂立课堂第二版,在SDK版上升级了业务模块,业务模块包括:用户、老师、学生、课程、课节、上课统计流水等。")
.version("v2."+version)
.license("Apache License Version 2.0")
.licenseUrl("https://www.apache.org/licenses/LICENSE-2.0")
.contact(new Contact("朱增亮", "", "zhuzengliang@onlyedu.com"))
.build();
}
}

访问

默认访问路径http://locahost:8080/swagger.html

knife4j

依赖包

compile group: 'com.github.xiaoymin', name: 'knife4j-spring-boot-starter', version: '2.0.4'

配置

原来的SwaggerConfig类上加入注解:

@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)

访问

默认访问路径http://locahost:8080/doc.html

看完上述内容是否对您有帮助呢?如果还想对相关知识有进一步的了解或阅读更多相关文章,请关注行业资讯频道,感谢您对的支持。

0