Swagger介绍-一套流行的API框架

Swagger被誉为世界上最流行的API框架,旨在减少前后台接口定义的沟通成本,提供接口测试和自动生成文档的功能。本文介绍了Swagger的两种使用方式,包括定义YAML文件和使用语言插件。在Java SpringMVC项目中,通过配置pom.xml、SwaggerConfiguration.java和SwaggerWebMvcConfigurerAdapter.java,以及在Controller中添加ApiOperation和ApiParam注解,即可实现接口文档的生成和Web界面的测试。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >


简介


号称:世界最流行的API框架

官网:http://swagger.io/

解决什么问题:在前后台分离的开发模式中,减小接口定义沟通成本,方便开发过程中测试,自动生成接口文档。

实例代码位置:https://github.com/pumadong/cl-roadshow/tree/master/roadshow-swagger


swagger使用方式


第一种

定义YAML文件,然后可以生成各种语言的代码框架,对于后台程序员来说,较少人会愿意写出一堆YAML格式。

第二种

swagger有各种语言的插件,可以通过配置及少量代码,生成接口文档及测试界面。

我们多做了:一次性的配置及少量注解代码。

我们不用再做:1、到Wiki中更新接口文档;2、Postman形式的测试;3、Curl形式的测试


swagger java使用介绍


对于一个SpringMVC项目,使用swagger的配置如下:

pom.xml

<!-- Swagger -->
<dependency>
    <
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值