Swagger2基本使用

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

废话篇

前言

接口文档对于前后端开发人员都十分重要。尤其近几年流行前后端分离后接口文档又变成重中之重。接口文档固然重要,但是由于项目周期等原因后端人员经常出现无法及时更新导致前端人员抱怨接口文档和实际情况不一致。

很多人员会抱怨别人写的接口文档不规范,不及时更新。但是当自己写的时候确实最烦去写接口文档。这种痛苦只有亲身经历才会牢记于心。

如果接口文档可以实时动态生成就不会出现上面问题Swagger可以完美的解决上面的问题。
即,使得前后端分离开发更方便

什么是openAPI

Open API规范(OpenAPI Specification)以前叫做 Swagger规范 是REST API的API描述格式
REST API 即同一个url根据不同的请求方式实现不同的功能

  • Open API文件允许描述整个 API,
  • 包括 每个访问地址的类型。POST或 GET
  • 每个操作的参数包括输入输出参数
  • 认证方法。
  • 连接信息,声明,使用团队和其他信息 Open API规范可以使用YAML 或JSON 格式进行编写。这样更利于我们和机器进行阅读。

Swagger简介

Swagger是一套围绕 Open API规范构建的开源工具,可以帮助设计,构建,记录和使用REST API。
Swagger 工具包括的组件:

Swagger Editor :基于浏览器编辑器,可以在里面编写 Open API规范。类似Markdown 具有实时预览描述文件的功能
Swagger UI: 将 Open API规范呈现为交互式 API 文档。用可视化 UI 展示描述文件Swagger Codegen :将
OpenAPI规范生成为服务器存根和客户端库。通过 SwaggerCodegen 可以将描述文件生成 html 格式和
cwiki形式的接口文档,同时也可以生成多种言语的客户端和服务端代码。 SwaggerInspector:和Swagger
UI有点类似,但是可以返回更多信息,也会保存请求的实际参数数据。 Swagger
Hub:集成了上面所有项目的各个功能,你可以以项目和版本为单位,将你的描述文件上传到 Swagger Hub 中。

在 Swagger Hub 中可以完成上面项目的所有工作需要注册账号,分免费版和收费版使用Swagger,就是把相关的信息存储在它定义的描述文件里面(yml或json 格式)再通过维护这个描述文件可以去更新接口文档,以及生成各端代码

Springfox

使用Swagger时如果碰见版本更新或迭代时,只需要更改 Swagger的描述文件即可。但是在频繁的更新项目版本时很多开发人员认为即使修改描述文件(yml或json)也是一定的工作负担,久而久之就直接修改代码,而不去修改描述文件了,这样基于描述文件生成接口文档也失去了意义
Marty Pitt 编写了一个基 Spring的组件 swaggerSpring-fox就是根springmv据这个组件发展而来的全新项目。
Spring-fox是根据代码生成接口文档,所以正常的进行更新项目版本,修改代码即可而不需要跟随修改描述文件
Spring-fox利用自身 AOP 特性,把 Swagger 集成进来,底层还是Swagger。但是使用起来确方便很多
所以在实际开发中,都是直接使用spring-fox

使用篇

swagger的基本使用

1、引入依赖

3.0版本需要添加springboot-starter

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
</dependency>

3.0以下的

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
</dependency>

2、配置config

3.0.0之前版本需使用@EnableSwagger2注解
3.0.0版本则不需要@EnableSwagger2注解,取而代之是@EnableOpenApi

swagger怎么访问,前端,java,spring boot
3、启动项目,访问swagger-ui界面url地址

3.0.0之前的版本访问是: /swagger-ui.html
3.0.0版本访问是: /swagger-ui/index.html

swagger怎么访问,前端,java,spring boot

4、配置相关信息

在swaggerConfig中bean类中配置相关的swagger信息文章来源地址https://www.toymoban.com/news/detail-728585.html

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(
                new ApiInfo("TITLE",
                        "description",
                        "version",
                        "",
                        new Contact("lio","https://blog.csdn.net/weixin_58286934?type=blog","510629467@qq.com"),
                        "li",
                        "http://www.baidu.com",
                        new ArrayList<VendorExtension>()))
                //是否启动swagger
                .enable(true)
                //RequestHandlerSelectors,配置要扫描接口的方式
                // basePackage: 配置要扫描的包
                // any(): 扫描全部
                // none():不扫
                // withclassAnnotation: 扫描类上的注解
                //withMethodAnnotation:扫描方法上的注解
                .select().apis(RequestHandlerSelectors.withMethodAnnotation(GetMapping.class))
                //过滤 any全部拒绝 none全部放行
                .paths(PathSelectors.ant("/swag/*"))
                .build();
    }

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

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

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

相关文章

  • springboot 集成 Swagger2 配置以及常用注解的说明和使用 ( 超详细)

    一、注解的使用 和 说明 结构化说明如下: @Api:用在请求的类上,表示对类的说明      tags=\\\"说明该类的作用,可以在UI界面上看到的注解\\\"    (也就是给类取别名)     value=\\\"该参数没什么意义,在UI界面上也看到,所以不需要配置\\\"    @ApiOperation:用在请求的方法上,说

    2024年02月03日
    浏览(47)
  • Springboot+swagger2

    1.swagger配置 2.请求路径  http://localhost:8006/swagger2/swagger-ui.html 3.Swagger2 注解整理  4.代码示例          

    2024年02月09日
    浏览(39)
  • SpringBoot 整合Swagger2

    Swagger是一套开源工具和规范,用于设计、构建和文档化 RESTful Web 服务。它允许开发人员定义API的各个方面,并生成易于理解的API文档和交互式API探索界面。同时,Swagger还提供代码生成工具,可自动生成与API交互的客户端和服务器端代码,提高开发效率。 官网:https://swagge

    2024年04月27日
    浏览(34)
  • SpringBoot整合Swagger2

    在团队开发中,一个好的 API 文档不但可以减少大量的沟通成本,还可以帮助一位新人快速上手业务。传统的做法是由开发人员创建一份 RESTful API 文档来记录所有的接口细节,并在程序员之间代代相传。这种做法存在以下几个问题: 1)API 接口众多,细节复杂,需要考虑不同

    2023年04月16日
    浏览(38)
  • 第二章:Swagger2

    目录 背景介绍 什么是Swagger2 常用注解 SpringBoot整合Swagger2 生产环境下屏蔽Swagger2 修改Swagger2配置类 修改application.yml 使用maven package打包测试 运行测试 在团队开发中,一个好的 API 文档不但可以减少大量的沟通成本,还可以帮助一位新人快速上手业务。传统的做法是由开发人员

    2024年02月22日
    浏览(42)
  • SpringBoot——Swagger2 接口规范

    优质博文:IT-BLOG-CN 如今, REST 和微服务已经有了很大的发展势头。但是, REST 规范中并没有提供一种规范来编写我们的对外 REST 接口 API 文档。每个人都在用自己的方式记录 api 文档,因此没有一种标准规范能够让我们很容易的理解和使用该接口。我们需要一个共同的规范和

    2024年02月04日
    浏览(46)
  • 微服务接口工具Swagger2

    ##1、什么是Swagger? 核心功能 生成接口说明文档 生成接口测试工具 1)、添加依赖 2)、增加Swagger配置类 如上代码所示,通过  @Configuration  注解,让 Spring 加载该配置类。再通过  @EnableSwagger2  注解来启用Swagger2。成员方法  createRestApi  函数创建  Docket  的Bean之后, apiInfo

    2024年01月17日
    浏览(39)
  • SpringCloud+Gateway+Swagger2

    做个笔记,并分享()。。。 学习链接: Spring Cloud Gateway系列【13】 整合knife4j实现网关聚合接口文档_knife4j-gateway-spring-boot-starter-CSDN博客 实现knife4j样式的接口文档;各个模块都加载到gateway; 效果图: 第一步:搭建SpringCloud框架(不具体写步骤了) 第二步:新建一个Gateway模

    2024年02月02日
    浏览(45)
  • Java技术-接口文档-Swagger2&Swagger3&接口文档UI整合

    目录 一、Swagger2完整用法 1.POM依赖 2.接口类 3.实现类 4.托管静态资源 5.接口文档配置 6.生产环境关闭接口文档 7.Swagger3页面效果 二、Swagger3完整用法 三、Swagger整合Knife4jUi 1.POM依赖 2.接口类 3.实现类 4.托管静态资源 5.接口文档配置 6.生产环境关闭接口文档 四、注释和参数讲解

    2024年02月16日
    浏览(49)
  • 一、SpringCloud+Gateway+Swagger2

    做个笔记,并分享()。。。 学习链接: Spring Cloud Gateway系列【13】 整合knife4j实现网关聚合接口文档_knife4j-gateway-spring-boot-starter-CSDN博客 实现knife4j样式的接口文档;各个模块都加载到gateway; 效果图: 第一步:搭建SpringCloud框架(不具体写步骤了) 第二步:新建一个Gateway模

    2024年01月19日
    浏览(36)

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

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

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

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

二维码1

领取红包

二维码2

领红包