• 草莓视频黄片在线看,草莓视频污污版,草莓视频成年人,草莓视频APP下载18

    歡迎來到《草莓视频黄片在线看》變頻草莓视频污污版設備官網
    精銳於專業 / 卓然於品質 -- 20年專注於草莓视频污污版行業,締造至臻品質 -- 服務熱線:0731-85783205 18932453205

    Swagger UI 詳細講解

    本文章描述的是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,會出現如下界麵。

      該頁麵加載的時候,會自動打開一個swagger接口規範文檔,如上圖輸入框中所示:http://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" ]} 屬性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按鈕,頁麵刷新後,如下所示:

    3.接口描述

     

    "paths":{ "/order/{orderId}":{ "get":{ "summary":"獲取訂單詳細信息", "description":"傳入訂單編號,獲取訂單信息", "parameters":[ { "name":"orderId", "in":"path", "description":"訂單Id", "required":true } ], "responses":{ "200":{ "description":"獲取用戶信息成功" } } } } }

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

    summary:接口主要功能的簡要描述description:接口詳細描述parameters:接口的參數,REST參數在Swagger中分為四個類型,以上實例的參數類型是path,也就是參數是從path中獲取的,其他的還有body,parameter等。response:對應了HTTP status的提示信息,這裏描述了成功的提示信息。4.查詢參數描述

     

    "parameters":[ { "name":"offset", "in":"query", "description":"查詢起始位置", "required":true } ] http://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" } } } }

     

     

    未完待續...

     

    猜你喜歡

    • 風機的基本性能參數有哪些 低壓風機的性能以及性能要求有哪些?

      低壓風機的性能主要就是節能,對於我國低壓風機性能的分析對比,在運行的經濟性方麵與以前的低壓風機沒有什麽區別,也沒有多少起伏性,而相對於低壓風機的性能來說,就具有非常大的發展以及創新,比如在送風的距離,比如在風量的變化幅度,比如在技術的發展狀

    • 高壓離心鼓風機的參數有哪些 高壓離心鼓風機的參數

      參數是很多機械設置或維修上能用到的一個選項,字麵上理解是可供參考的數據,但有時又不全是數據。對指定應用而言,高壓風機廠家可以是賦予的常數值;在泛指時,它可以是一種變量,用來控製隨其變化而變化的其他的量。簡單說,參數是給草莓视频黄片在线看參考的。那麽高壓風

    • 高壓風機參數 標準規格高壓風機的選擇可以從哪些方麵入手

      與其它機械零件相比,高壓旋渦風機的規格種類較多,品種較多,因此客戶在選擇產品類型時會比較苦惱,因此建議客戶選擇合適的高壓風機,可以直接將各種配置配置成可供客戶使用的高壓風機。那標準規格的高壓風機可以從哪些方麵著手?一、選擇承軸型號通用。標準

    • wq係列潛水排汙泵型號_WQ潛水排汙泵型號參數及含義

      潛汙泵從字麵上就能理解是潛水式的汙水泵,常見的就是WQ型潛水排汙泵,全稱是WQ潛水式高效無堵塞排汙泵。這裏給大家做一些型號含義。一、型號參數及含義。Q:潛水W:排汙G:管道Y:自吸L:垂直P:草莓视频成年人B:防爆JY:攪勻像JYWQ

    • 化工泵型號參數的意義和作用_化工泵型號參數的意義

      目前,國內廠家生產的化工泵主要包括:dkzb型草莓视频成年人撓性泵,dby型電動隔膜泵,hkzb滑片泵,IH型化工泵,IHF型氟塑料化工泵,FSB型氟塑料化工泵,CQB化學磁力泵,IMD化工磁力泵,FZB化工自吸泵等。這些化工泵被廣使用在化工、冶金

    • 如何選擇消防泵的參數_怎樣選擇消防泵?

      消防泵是消防設施中經常使用和必不可少的組件。消防泵的正常運行在滅火過程中起著決定性的作用。那麽,怎樣選擇消防泵?以下是給大家簡要介紹選擇消防泵的知識。要查看消防泵是否通過了我國強製檢查,有必要查看由消防產品合格評定中心發布的近一年的強製檢查

    18932453205
    網站地圖