swagger的使用

AuroraEle.

已于 2023-06-25 13:45:43 修改

阅读量92

点赞数

文章标签： spring java

于 2023-06-25 11:56:38 首次发布

本文链接：https://blog.csdn.net/weixin_45053776/article/details/131374555

版权

在前后端分离项目中，为了解决后端编码人员的接口测试需求，文章推荐使用SpringDoc来替代传统swagger，因为SpringDoc能避免版本不兼容问题并自动扫描接口。通过添加特定的maven依赖，配置application.properties以设置路径匹配策略，并创建Swagger配置类，可以轻松实现接口文档的生成。运行程序后，访问特定URL即可查看接口文档。

摘要由CSDN通过智能技术生成

Swagger的使用
使用需求：由于在编写前后端分离项目时后端编码人员需要对接口进行测试，所以需要使用接口测试工具。小编推荐使用SpringDoc的方式来使用swagger因为正常引入springboot ✚ swagger会出现版本不兼容的情况。而且其会自动扫描接口无需配置。

pom.xml填写内容

	<dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
        <version>2.0.2</version>
    </dependency>

application.properties 填写内容
yml方式请自行调整

	spring.mvc.pathmatch.matching-strategy=ant_path_matcher

编写配置类

	@Configuration
	public class SwaggerConfig {
  	 	 @Bean
   		 public OpenAPI springOpenAPI() {
        		return new OpenAPI().info(new Info()
                	.title("SpringDoc API Test") 
                	.description("SpringDoc Simple Application Test") 
                	.version("0.0.1"));
    	}
	}

运行程序
在浏览器中输入 IP地址:端口号/swagger-ui/index.html
运行效果