java Swagger 配置技巧

本文介绍了如何使用Swagger来自动化维护API文档,重点讲解了Swagger的核心组件、Springfox的集成以及API扫描配置。Swagger UI提供交互式文档,Swagger Codegen则能自动生成SDK。此外,文章还提到了Knife4j的文档使用以及接口的注解分类和说明。
摘要由CSDN通过智能技术生成

引言

后端修改了接口,需要手动维护api文档,加大了开发的工作量和困难,而swagger的出现就是为了解决这一系列的问题。

swagger是一套基于OpenAPI规范构建的开源工具,使用RestApi

  1. 代码变,文档变
  2. 跨语言,支持多种语言
  3. swagger-ui 呈现出来的是一份可交互式的API文档,可以直接在文档页面尝试API的调用
  4. 可以将文档规范导入相关工具(postman、soapui),这些工具将会为我们自动地创建自动化测试

RestApi格式是根据请求的方式决定本次请求的一个操作,譬如:get–>读,post–>写(增、删、改),put–>修改,delete–>删除。https://www.ibm.com/cn-zh/cloud/learn/rest-apis

OpenApi与语言无关,只是一种规范,可以使用yaml和json格式进行编写,这样更利于我们和机器进行阅读

<

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

iOS逆向

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值