建站行业分析,宁德网站建设,宁津做网站,自己设置免费网站设计平台Swagger介绍
Swagger 是一套用于设计、构建、文档化和测试 RESTful API 的开源工具集#xff0c;它提供了一种标准化的方式来描述 API 的结构、请求参数、响应格式等信息#xff0c;使得前后端开发人员能够更高效地协作。
使用Swagger只需要按照它的规范去定义接口及接口相…Swagger介绍
Swagger 是一套用于设计、构建、文档化和测试 RESTful API 的开源工具集它提供了一种标准化的方式来描述 API 的结构、请求参数、响应格式等信息使得前后端开发人员能够更高效地协作。
使用Swagger只需要按照它的规范去定义接口及接口相关信息就可以做到生成接口文档以及在线调试页面官网: https://swagger.io/ Knife4j 是为java MVC框架集成Swagger生成API文档的增强解决方案。
主要使用过程
1、导入knife4j的maven坐标pom.xml 文件中导入坐标
dependencygroupIdcom.github.xiaomin/groupIdartifactIdknife4j-spring-boot-start/artifactIdversion3.0.2/version
/dependency2、在配置类中加入knife4j的相关配置 Bean
// 注解表示由Spring容器创建并管理public Docket docket() {//构建生成接口文档的一系列信息ApiInfo apiInfo new ApiInfoBuilder().title(XXX).version(XX).description(XXX).build();Docket docket new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).select()//指定生成接口需要扫描的包.apis(RequestHandlerSelectors.basePackage(com.sky.controller)).paths(PathSelectors.any()).build();return docket;}3、设置静态资源映射否则接口文档页面无法访问 protected void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler(/doc.html).addResourceLocations(classpath:/META-INF/resources/);registry.addResourceHandler(/webjars/**).addResourceLocations(classpath:/META-INF/resources/webjars/);}常用注解
