千家信息网

如何使用Swagger调试RESTful风格的接口

发表于:2025-01-29 作者:千家信息网编辑
千家信息网最后更新 2025年01月29日,这篇文章将为大家详细讲解有关如何使用Swagger调试RESTful风格的接口,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。Swagger:世界上最流
千家信息网最后更新 2025年01月29日如何使用Swagger调试RESTful风格的接口

这篇文章将为大家详细讲解有关如何使用Swagger调试RESTful风格的接口,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。

Swagger:

世界上最流行的API工具. 全球最大的OpenAPI规范(OAS)API开发工具框架,支持从设计,文档,测试以及部署的整个API生命周期的开发.

pom.xml添加maven依赖:

org.ramer.demo下新建类: config.ApiDocConfig:

红色部分指定swagger-ui扫描的基础包.

修改CommonController.java:

@ApiOperation: 指定方法说明

@APIResponses: 指定方法响应码及对应的消息

同样,可以在实体类上添加相关信息

启动项目访问: http://localhost:8080/swagger-ui.html

依次点击展开common-controller,/users,并填入测试值:

点击"Try it out!"

关于如何使用Swagger调试RESTful风格的接口就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。

0