规范门户网站建设,备案期间 网站想正常,店面设计费入什么科目,南阳做玉器网站Swagger 接口文档的整合#xff1a;
引入依赖#xff08;Swagger 或 Knife4j#xff09;。自定义 Swagger 配置类。定义需要生成接口文档的代码位置#xff08;Controller#xff09;。注意#xff1a;线上环境不要把接口暴露出去#xff01;#xff01;#xff01;可…Swagger 接口文档的整合
引入依赖Swagger 或 Knife4j。自定义 Swagger 配置类。定义需要生成接口文档的代码位置Controller。注意线上环境不要把接口暴露出去可以通过在 SwaggerConfig 配置文件开头加上 Profile({“dev”, “test”}) 限定配置仅在部分环境开启。启动接口文档。可以通过在 controller 方法上添加 Api、ApiImplicitParam(name “name”,value “姓名”,required true) ApiOperation(value “向客人问好”) 等注解来自定义生成的接口描述信息
Swagger
Swagger 官网
依赖引入 !-- swagger 接口文档 --dependencygroupIdio.springfox/groupIdartifactIdspringfox-swagger2/artifactIdversion2.9.2/version/dependencydependencygroupIdio.springfox/groupIdartifactIdspringfox-swagger-ui/artifactIdversion2.9.2/version/dependency创建 config 文件
package com.heo.matchmatebackend.config;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;/*** 自定义 Swagger 接口文档的配置*/
Configuration // 配置类
EnableSwagger2 // 开启 swagger2 的自动配置
Profile({dev, test}) //版本控制访问
public class SwaggerConfig {Bean(value defaultApi2)public Docket docket() {// 创建一个 swagger 的 bean 实例return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())// 配置接口信息.select() // 设置扫描接口// 配置如何扫描接口.apis(RequestHandlerSelectors//.any() // 扫描全部的接口默认//.none() // 全部不扫描.basePackage(com.heo.matchmatebackend.controller) // 扫描指定包下的接口最为常用//.withClassAnnotation(RestController.class) // 扫描带有指定注解的类下所有接口//.withMethodAnnotation(PostMapping.class) // 扫描带有只当注解的方法接口).paths(PathSelectors.any() // 满足条件的路径该断言总为true//.none() // 不满足条件的路径该断言总为false可用于生成环境屏蔽 swagger//.ant(/user/**) // 满足字符串表达式路径//.regex() // 符合正则的路径).build();}/*** api 信息* return*/private ApiInfo apiInfo() {Contact contact new Contact(heo, // 作者姓名https://blog.csdn.net/XiugongHao, // 作者网址xxxqq.com); // 作者邮箱return new ApiInfoBuilder().title(matchmate) // 标题.description(matchmate 接口文档) // 描述.termsOfServiceUrl(https://blog.csdn.net/XiugongHao) // 跳转连接.version(1.0) // 版本.contact(contact).build();}
}
yml 配置(如果 springboot version 2.6需要添加如下配置 pathmatch)
spring:mvc:pathmatch:matching-strategy: ant_path_matcherprofiles:active: dev最后运行启动。
http://localhost:8080/api/swagger-ui.html Knife4j
Knife4j 官网
依赖引入。 !-- knife4j 接口文档 --dependencygroupIdcom.github.xiaoymin/groupIdartifactIdknife4j-spring-boot-starter/artifactIdversion2.0.7/version/dependencyconfig 文件配置。
package com.heo.matchmatebackend.config;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;/*** 自定义 Swagger 接口文档的配置*/
Configuration // 配置类
EnableSwagger2 // 开启 swagger2 的自动配置
Profile({dev, test}) //版本控制访问
public class SwaggerConfig {Bean(value defaultApi2)public Docket docket() {// 创建一个 swagger 的 bean 实例return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())// 配置接口信息.select() // 设置扫描接口// 配置如何扫描接口.apis(RequestHandlerSelectors//.any() // 扫描全部的接口默认//.none() // 全部不扫描.basePackage(com.heo.matchmatebackend.controller) // 扫描指定包下的接口最为常用//.withClassAnnotation(RestController.class) // 扫描带有指定注解的类下所有接口//.withMethodAnnotation(PostMapping.class) // 扫描带有只当注解的方法接口).paths(PathSelectors.any() // 满足条件的路径该断言总为true//.none() // 不满足条件的路径该断言总为false可用于生成环境屏蔽 swagger//.ant(/user/**) // 满足字符串表达式路径//.regex() // 符合正则的路径).build();}/*** api 信息* return*/private ApiInfo apiInfo() {Contact contact new Contact(heo, // 作者姓名https://blog.csdn.net/XiugongHao, // 作者网址xxxqq.com); // 作者邮箱return new ApiInfoBuilder().title(matchmate) // 标题.description(matchmate 接口文档) // 描述.termsOfServiceUrl(https://blog.csdn.net/XiugongHao) // 跳转连接.version(1.0) // 版本.contact(contact).build();}
}
yml 配置。
spring:mvc:pathmatch:matching-strategy: ant_path_matcherprofiles:active: dev启动。
http://localhost:8080/api/doc.html#/home
