Swagger-的使用

这篇具有很好参考价值的文章主要介绍了Swagger-的使用。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

前言

在我们和前端进行交互的时候,出接口文档是一件必须的事情,如果手写接口文档是一件很折磨人的事情,不管是前端还是后端开发,多多少少都会被接口文档所折磨,前端会抱怨后端没有及时更新接口文档,而后端又会觉得编写接口文档太过麻烦。通过swagger可以很好的解决这个问题

效果

Swagger-的使用,springboot,spring boot,swagger,接口文档

1、相关依赖

Swagger-的使用,springboot,spring boot,swagger,接口文档

<!-- https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui -->
		<dependency>
			<groupId>org.springdoc</groupId>
			<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
			<version>2.3.0</version>
		</dependency>

2、相关注解

Swagger-的使用,springboot,spring boot,swagger,接口文档

2.1 @Tag设置整个类的名称和详情

Swagger-的使用,springboot,spring boot,swagger,接口文档

Swagger-的使用,springboot,spring boot,swagger,接口文档

Swagger-的使用,springboot,spring boot,swagger,接口文档

2.2 @Operation描述具体的方法

Swagger-的使用,springboot,spring boot,swagger,接口文档

Swagger-的使用,springboot,spring boot,swagger,接口文档
Swagger-的使用,springboot,spring boot,swagger,接口文档

2.3 @Parameter 描述参数

Swagger-的使用,springboot,spring boot,swagger,接口文档
Swagger-的使用,springboot,spring boot,swagger,接口文档

2.4@Schema 为属性添加注释

Swagger-的使用,springboot,spring boot,swagger,接口文档

Swagger-的使用,springboot,spring boot,swagger,接口文档

3、Docket配置

3.1通过gropeediopenapi进行分组

Swagger-的使用,springboot,spring boot,swagger,接口文档

Swagger-的使用,springboot,spring boot,swagger,接口文档

3.2 通过docsOpenApi设置

Swagger-的使用,springboot,spring boot,swagger,接口文档
Swagger-的使用,springboot,spring boot,swagger,接口文档
Swagger-的使用,springboot,spring boot,swagger,接口文档文章来源地址https://www.toymoban.com/news/detail-827254.html

到了这里,关于Swagger-的使用的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Spring Boot整合Spring Fox生成Swagger文档

    Springfox是一个用于在Spring应用程序中生成Swagger文档的开源库。它提供了一组注解和工具,可以将你的API代码和文档整合在一起,方便生成和展示API的Swagger文档。 使用Springfox,你可以在Spring Boot项目中集成Swagger,并通过Swagger UI查看和测试API。它提供了一些注解,如 @Api 、 @

    2024年02月08日
    浏览(41)
  • 【SpringBoot】Swagger&Knif4j接口文档集成

    目录 序:接口文档 1 Swagger 1.1 基本信息 1.2 接入步骤 2 Knife4j 2.1 基本信息 2.2 接入步骤 ​在开发过程中,接口文档是非常重要的一环,在 Spring Boot 中,我们可以通过集成第三方来实现接口文档的自动生成。 ​通过注解来描述接口,然后根据这些注解自动生成接口文档,它不

    2024年02月04日
    浏览(43)
  • Springboot配置Swagger展示API文档并进行接口测试(doc.html、swagger-ui.html)

    三、创建一个测试接口 http://localhost:8080/doc.html http://localhost:8080/swagger-ui.html

    2024年02月10日
    浏览(39)
  • 【SpringBoot】SpringBoot引入接口文档生成工具(Swagger+Knife4j)

    由于目前工作项目写的接口越来越多了,为了能够更加方便地优化接口,以及整理接口文档,所以就考虑引入接口文档生成工具。目前的接口文档生成工具被提及较多的是Swagger,经过了引入尝试后,Swagger是比较轻松地就被引入了。但是Swagger页面属实是难以恭维,比较简单但

    2024年01月23日
    浏览(37)
  • Swagger接口文档的导出使用

    1.配置项目swagger2 帮助网站:https://blog.csdn.net/xhmico/article/details/125353535 配置完成后,运行项目,打开 http://localhost:8868/mike/swagger-ui.html# (注意端口) ,如下: 点击红圈链接,会生成 json 格式的接口文档,如下图: 2.生成文档 点击下方链接: 在线swagger转word文档|swagger导出w

    2024年02月09日
    浏览(40)
  • gin中使用swagger生成接口文档

    想要使用 gin-swagger 为你的代码自动生成接口文档,一般需要下面三个步骤: 按照swagger要求给接口代码添加声明式注释,具体参照声明式注释格式。 使用swag工具扫描代码自动生成API接口文档数据 使用gin-swagger渲染在线接口文档页面 第一步:添加注释 在程序入口main函数上以

    2024年01月25日
    浏览(40)
  • Spring Cloud Gateway集成Swagger实现微服务接口文档统一管理及登录访问

    本文将介绍如何在 Spring Cloud 微服务中使用 Swagger 网关来统一管理所有微服务的接口文档,并通过 Spring Security 实现登录后才能访问 Swagger 文档,以确保接口数据的安全访问。 在开始之前,需要假设你已经完成了 Spring Cloud Gateway 的相关配置,并且已经了解了基本的网关配置知

    2024年02月05日
    浏览(42)
  • 记录spring boot项目中新增模块在swagger中不显示新增接口的问题

    1、先排查新增接口是否添加了对应的@RequestMapping和@Controller注解 ; 2、若第一步所需注解均已添加,则排查新增模块的父级模块pom中是否新增了对应新加的模块;【红框中为新增的子模块】 3、排查 父级模块的父级模块的pom文件中是否添加了新增的模块依赖。 4、排查启动类

    2024年02月05日
    浏览(64)
  • Spring Boot 集成 API 文档 - Swagger、Knife4J、Smart-Doc

    Swagger 作为 API 设计和文档的强大工具,是一个由专门的工具集合支持的框架,它在整个 API 的生命周期中发挥作用,从设计和文档,到测试和部署。通过提供可视化界面,Swagger 让开发人员和最终用户都能清晰地理解和操作 API。 使用建议:笔者建议优先考虑 Knife4J,它已经能

    2024年01月22日
    浏览(56)
  • SpringBoot - 集成Swagger2、Knife4j接口文档/升级版swagger-bootstrap-ui配置以及账号密码登录

    请注意@Configuration和@EnableSwagger2注解。这两个注解分别表示这是一个配置类,以及启用了Swagger 2。只有在这两个注解都存在的情况下,Swagger才会被正确启用。 如果您的项目使用的是Swagger 3(即OpenAPI 3),则配置文件可能如下所示: 访问 http://localhost:8080/swagger-ui.html (假设项

    2024年02月08日
    浏览(39)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包