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)


相关推荐

  • 大数据分析应用领域有哪些[通俗易懂]

    大数据分析应用领域有哪些[通俗易懂]  软件和服务的大数据分析市场收入预计将从2018年的$42B增长到2027年的$103B,复合年增长率(CAGR)为10.48%。这就是为什么,大数据分析认证是业内最全神贯注的技能之一。在这个“大数据分析应用领域”文章中,我将带您进入各个行业领域,在这里我将解释大数据分析如何使它们发生革命性变化。  大数据分析应用  大数据分析应用程序的主要目标是通过分析大量数据来帮助公司做出更具信息量的业务决策。它可能包括Web服务器日志,Internet点击流数据,社交媒体内容和活动报告,来自客户电子邮

  • python和java哪个就业更好_python和JAVA的区别

    python和java哪个就业更好_python和JAVA的区别一、从几个方面进行比较Python和Java都是目前最为流行的编程语言,到底哪一个更好找工作,比较以下几个方面可以提供一些参考价值。1、就业现状从目前的就业现状来看,Java的工作机会肯定是更多的,如Web开发、大数据开发和移动互联网开发等都是基于Java的应用方向。正是因为应用方向多,所以存在人才发展跟不上市场的需求的现状,因此长期来看Java的霸主地位是不会动摇的。但Python是更面向未来的。毕竟我国把发展人工智能作为国策大力推动。大数据、人工智能、数据分析都是基于Python…

    2022年10月25日
  • 史上最全面的JTAG和SWD接口的定义/STM32/STM8工程师的福音/JTAG转SWD接口仿真/告别杂乱的仿真线/终于讲清楚了JTAG/SWD

    史上最全面的JTAG和SWD接口的定义/STM32/STM8工程师的福音/JTAG转SWD接口仿真/告别杂乱的仿真线/终于讲清楚了JTAG/SWD一、前言作为一名嵌入式工程师,相信大家都十分清楚MCU开发或者ARM开发都避免不了关键的研发过程,产品研发过程中的程序调试更是举足轻重般的存在。从8051内核到ARM内核,自己也接触了很多的调试工具和调试手段;今天在此给大家分享一下使用ST-LINK仿真调试器的一些基础知识和好物推荐。二、ST-LINK仿真器说明ST-Link是用于STM8和STM32微控制器在线调试器和编程器,ST-Link本身具有SWIM、JTAG/SWD通信接口,适用于STM8和STM32微控制器的软件调试仿真。

  • vue引入图片url变量

    vue引入图片url变量1.引入方式普通引入<template>//普通引入<imgsrc=”../assets/images/01.jpg”>//webpack编译处理后:<imgsrc=”/img/01.f0afc36d.jpg”><template>变量引入<template>…

  • pfSense2.3x安装教程

    pfSense2.3x安装教程

  • idea整理代码快捷键设置_idea常用快捷键和配置

    idea整理代码快捷键设置_idea常用快捷键和配置问题解决:Ctrl+Alt+L

    2022年10月12日

发表回复

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

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