这篇文章将介绍如何在 java 中使用 ,
官网地址:https://swagger.io/
是一个规范和完整的框架,用于生成可视化 RESTful 风格的 Web 服务。是一个简单且功能强大的API工具。几乎所有的现代编程语言,都在支持和使用。
Swagger2已经停止维护了,取而代之的是 swagger3,
之前在SpringBoot项目中一直使用的是提供的Swagger库,已经很久没有更新了。
是一款可以结合SpringBoot使用的API文档生成工具,基于OpenAPI 3,
是一款更好用的Swagger库!值得一提的是SpringDoc不仅支持Spring WebMvc项目,还可以支持Spring WebFlux项目,甚至Spring Rest和Spring Native项目,总之非常强大
经常使用的Swagger注解,看看的有啥区别,毕竟对比已学过的技术能更快掌握新技术;
进行SpringDoc的配置,使用来配置基础的文档信息,通过配置分组的API文档,SpringDoc支持直接使用接口路径进行配置。
1.@Tag注解
用来描述一组操作的信息(通常用在controller控制层类上)
例:
2.@Operation注解
用来描述接口信息(通常用在控制层的具体方法上)
例:
3.@Schema注解
该注解用来定义模型及模型的属性(可以用在dto/vo以及其属性上)
例:
到此这篇swagger3使用(swagger怎么使用)的文章就介绍到这了,更多相关内容请继续浏览下面的相关推荐文章,希望大家都能在编程的领域有一番成就!迁移到SpringDoc确实是一个更好的选择。确实很好用,和之前熟悉的用法差不多,。
版权声明:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符,请将相关资料发送至xkadmin@xkablog.com进行投诉反馈,一经查实,立即处理!
转载请注明出处,原文链接:https://www.xkablog.com/rfx/21196.html