vue前端ui框架_详细讲解帕米尔的春天

vue前端ui框架_详细讲解帕米尔的春天本文章描述的是Swagger3.0的内容,与Swagger2.0内容有较大差别。接口描述在3.0中通过Swagger规范(一个JSON文件)来描述,Swagger2.0是通过在接口中提供一系列注解来描述的。 1.集成Swagger    Swagger提供了一组静态页面,可以在SpringBoot应用中集成这些静态页面,直接访问静态页面,并打开指定的Swagger规范,就可以…

大家好,又见面了,我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全家桶1年46,售后保障稳定

本文章描述的是Swagger3.0的内容,与Swagger2.0内容有较大差别。接口描述在3.0中通过Swagger规范(一个JSON文件)来描述,Swagger2.0是通过在接口中提供一系列注解来描述的。

 

1.集成Swagger 

      Swagger提供了一组静态页面,可以在SpringBoot应用中集成这些静态页面,直接访问静态页面,并打开指定的Swagger规范,就可以显示RESTFul接口:

  • 进入Swagger官网,选择Swagger UI,点击下载。
  • 页面会跳转到GitHub
  • 在GitHub中,选择一个最新的版本下载,目前最新的是Swagger UI 3.20.5.
  • 下载解压后,找到dist目录,将目录里面所有的文件复制到新的SpringBoot项目中src\main\resources\static\swagger3\目录下面。
  • 访问http://localhost:8080/swagger3/index.html,会出现如下界面。

vue前端ui框架_详细讲解帕米尔的春天

  该页面加载的时候,会自动打开一个swagger接口规范文档,如上图输入框中所示:https://petstore.swagger.io/v2/swagger.json

  打开后的页面分为两部分,第一部分为接口的基本信息,包含了项目名称,描述等信息;第二部分包含了每个接口的具体描述,如接口名字,参数名字,参数类型,是否必填等,还有返回的结果的示例。

注意:默认提供的Petstore接口调用并不能成功,因为这涉及跨域问题,在localhost环境下发起对petstore.swagger.io的AJAX调用会导致失败。

2.Swagger规范

    swagger规范是一个JSON格式的文件,包含项目基本信息及具体接口描述信息,可以在swagger3下创建一个sample.json文件,我们将逐渐完善。

{
  "swagger":"2.0",
  "info":{
    "description":"这是一个项目简单实例",
    "version":"1.0",
    "tirle":"系统接口",
  },
  "basePath":"/api/v1",
  "consumes":[
    "application/x-www-form-urlencode"
  ]
}

Jetbrains全家桶1年46,售后保障稳定

  • 属性swagger总是规范的第一个属性,固定为2.0,指的是Swagger规范2.0。
  • info描述了一个项目的基本信息。
  • basePath:指的是RESRFul接口的实际地址,以上是/api/v1,则REST接口的地址则是127.0.0.1:8080/api/v1。
  • consumes:指提交的内容是表单。

重新访问网址http://localhost:8080/swagger3/index.html,并且在页面填写规范地址:

http://localhost:8080/swagger3/sample.json

点击Explore按钮,页面刷新后,如下所示:

vue前端ui框架_详细讲解帕米尔的春天

3.接口描述

 

"paths":{
     "/order/{orderId}":{
       "get":{
         "summary":"获取订单详细信息",
         "description":"传入订单编号,获取订单信息",
         "parameters":[
           {
             "name":"orderId",
             "in":"path",
             "description":"订单Id",
             "required":true
           }
         ],
         "responses":{
           "200":{
             "description":"获取用户信息成功"
           }
         }
       }
     }
  }

vue前端ui框架_详细讲解帕米尔的春天

每个接口包含了以下信息:

  • summary:接口主要功能的简要描述
  • description:接口详细描述
  • parameters:接口的参数,REST参数在Swagger中分为四个类型,以上实例的参数类型是path,也就是参数是从path中获取的,其他的还有body,parameter等。
  • response:对应了HTTP status的提示信息,这里描述了成功的提示信息。

4.查询参数描述

 

        "parameters":[
          {
            "name":"offset",
            "in":"query",
            "description":"查询起始位置",
            "required":true
          }
        ]
https://localhost:8080/api/v1/order?offset=12

5.HTTP头参数

        "parameters":[
          {
            "name":"X-Request-ID",
            "in":"header",
            "description":"",
          }
        ]

6.表单参数

使用application/x-www-form-urlencoded提交的参数,in的值使用formData。

        "parameters":[
          {
            "name":"orderName",
            "in":"formData",
            "description":"",
            "required":true
          }
        ]

7.文件上传参数 

        "parameters":[
          {
            "name":"orderName",
            "in":"formData",
            "description":"",
            "type":"file"
          }
        ]

8.整个请求体作为参数

    "/order":{
      "post":{
        "summary":"创建订单",
        "description":"创建一个新订单",
        "parameters":[
          {
            "name":"order",
            "in":"body",
            "description":"包含订单信息的JSON",
            "required":true,
            "schema":{
              "$ref":"#/definitions/order"
            }
          }
        ],
        "responses":{
          "200":{
            "description":"创建订单成功"
          }
        }
      }
    }
  "definitions":{
    "order":{
      "type":"object",
      "properties":{
        "id":{
          "type":"string"
        },
        "name":{
          "type":"string"
        }
      }
    }
  }

 

 

未完待续…

 

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/226802.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)
blank

相关推荐

  • GTest 总结_gtest单元测试

    GTest 总结_gtest单元测试GoogleC++单元测试框架(简称Gtest),可在多个平台上使用(包括Linux,MacOSX,Windows,Cygwin和Symbian),它提供了丰富的断言、致命和非致命失败判断,能进行值参数化测试、类型参数化测试、“死亡测试”。1断言一般的,要测试一个方法(函数)是否是正常执行的,可以提供一些输入数据,在调用这个方法(函数)后,得到输出数据,然后检查输出的数据是否与我们期望的结果是一致的,若一致,则说明这个方法的逻辑是正确的,否则,就有问题。在对输出结果进行检查(chec.

  • idea2021激活码(破解版激活)

    idea2021激活码(破解版激活),https://javaforall.cn/100143.html。详细ieda激活码不妨到全栈程序员必看教程网一起来了解一下吧!

  • 关于雅虎优化

    关于雅虎优化尽可能的减少HTTP的请求数[content]合并背景图、缓存等使用CDN(ContentDeliveryNetwork)[server]也是缓存,加速,要考虑CDN失效、CDN缓

  • 解决iframe高度自适应「建议收藏」

    解决iframe高度自适应「建议收藏」解决iframe高度自适应原因第一种方法第二种方法原因iframe的高度不会随着页面高度的变化而变化,可能会导致页面显示不全,或者页面下方有空白的问题。第一种方法这个方式更适用于嵌套的页面,当嵌套多个iframe时,比如左侧有个侧边栏,右侧是个大的iframe,这个大的iframe又嵌套了一层:中间是iframe,但是右侧又有个侧边栏,这时候不想让iframe单独滑动(避免页面出现两个滚动条),而是想整个页面一起滑动时,用这个方法。html代码:注意一定要写height=‘100%’scrol

    2022年10月25日
  • Java之反射机制详解「建议收藏」

    Java之反射机制详解「建议收藏」反射机制反射机制在java.lang.reflect.*包下反射机制相关的重要的类有java.lang.Class:代表字节码文件java.lang.reflect.Method:代表字节码中的方法字节码java.lang.reflect.Constructor:代表字节码中的构造方法字节码java.lang.reflect.Field:代表字节码中的属性字节码反射机制有什么用通过java语言中的反射机制可以操作字节码文件。有点类似于黑客(可以读和修改字节码文件。)通过反射机制可以操作代

  • 数据结构与算法栈的详解_数据结构怎么判断出栈的顺序

    数据结构与算法栈的详解_数据结构怎么判断出栈的顺序一、什么是栈栈(stack)是一种先进后出的有序列表,其中的元素只能在线性表的同一端进出,允许元素插入和删除的一端被称为栈顶(top),固定的另一端被称为栈底(button)。二、数组简单实现栈

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号