springboot项目中swagger配置
2024-09-08 11:06:32
1、导入依赖
查看代码
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
2、定义配置文件
查看代码
package com.hyl.config;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
@EnableKnife4j
public class WebMvcConfig extends WebMvcConfigurationSupport {
/**
* 设置静态资源映射
* @param registry
*/
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
//swagger
@Bean
public Docket createRestApi() {
// 文档类型
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//这儿扫描自己controller包就可以
.apis(RequestHandlerSelectors.basePackage("com.hyl.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("testSwagger")
.version("1.0")
.description("接口描述")
.build();
}
}
3、编写启动项 和yml文件
查看代码
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class,args);
}
}
4、启动项目
浏览器地址栏输入:localhost:端口号:/doc.html
就可以看到生成的文档页面。
5、效果图
6、这里只是简单介绍一下配置,后续想要更完善,可以给接口类或者方法,以及一些实体类上以及属性加上注解。
这里简单罗列几个常用的注解
@Api(value = "/user",tags = "用户接口")
@ApiOperation(value = "用户登录", notes = "用户登录")
@ApiModel("")
@ApiModelProperty("用户id")
最新文章
- Android IOS WebRTC 音视频开发总结(七八)-- 为什么WebRTC端到端监控很关键?
- 安卓开发_浅谈Android动画(一)
- ubuntu + hadoop2.5.2分布式环境配置
- Summary: Final Keyword
- [Angular 2] Select From Multiple Nested Angular 2 Elements
- spring boot单元测试(转)
- javascript 基础API
- iOS VoiceOver Programming Guide
- BadgeView新提示开源工具类
- SimpleDateFormat类
- Centos6.3下搭建apache+https服务
- selenium+phantomjs+pyquery 爬取淘宝商品信息
- zabbix 监控 WEB 应用性能
- BZOJ2212 [Poi2011]Tree Rotations 线段树合并 逆序对
- Java驱动远程连接mongoDB(简明易懂版)
- xmlns 实例分析
- jQuery获取Table某列的值
- 面试题2:单例模式Singleton
- 说说wee sing(ZZ)
- jQuery速看