摘要:在的下有示例寫法。拿過(guò)來(lái)分析記錄。官方注解文檔標(biāo)題部分接口文檔測(cè)試文檔項(xiàng)目效果圖接口所支持的協(xié)議可以填多種協(xié)議主機(jī)名或。提供的基本路徑,它是相對(duì)于。必須以一個(gè)前導(dǎo)斜杠開(kāi)始是拼接出來(lái)的。描述跳轉(zhuǎn)鏈接聯(lián)系開(kāi)發(fā)者,發(fā)送郵件。
在swagger-php的Example下有示例寫法。拿過(guò)來(lái)分析記錄。
swagger官方注解:https://bfanger.nl/swagger-explained/#schemaObject go
1. 文檔標(biāo)題部分</>復(fù)制代碼
/**
* @SWGSwagger(
* schemes={"http"},
* host="api.com",
* basePath="/v1",
* @SWGInfo(
* version="1.0.0",
* title="API接口文檔",
* description="測(cè)試swagger文檔項(xiàng)目",
* @SWGContact(
* name="wxp",
* email="panxxxx@163.com"
* )
* ),
* @SWGExternalDocumentation(
* description="wxp",
* url="./"
* )
* )
*/
效果圖:
schemes: 接口所支持的協(xié)議 (可以填多種協(xié)議)
host:主機(jī)名或ip。
basePath:提供API的基本路徑,它是相對(duì)于host。必須以一個(gè)前導(dǎo)斜杠(/)開(kāi)始. Base URL 是 host + basePath 拼接出來(lái)的。
Info : 文檔描述。
version :版本號(hào)。
title :標(biāo)題。
description : 描述信息。
ExternalDocumentation":外部文檔鏈接。
description:描述
url :跳轉(zhuǎn)鏈接
Contact :聯(lián)系開(kāi)發(fā)者,發(fā)送郵件。
name : 開(kāi)發(fā)者姓名
email :郵件地址。
2. tag標(biāo)簽部分,用于文檔分類</>復(fù)制代碼
/**
* @SWGTag(
* name="pet",
* description="你的寵物信息",
* @SWGExternalDocumentation(
* description="查看更多",
* url=""
* )
* )
* @SWGTag(
* name="store",
* description="查看寵物店訂單"
* )
* @SWGTag(
* name="user",
* description="用戶操作記錄",
* @SWGExternalDocumentation(
* description="關(guān)于寵物店",
* url="http://swagger.io"
* )
* )
*/
name : 名稱(功能模塊)
description : 描述
3. 接口注釋寫法</>復(fù)制代碼
/**
* @SWGGet(
* path="/pet/{petId}",
* summary="通過(guò)ID查詢寵物",
* description="返回寵物信息",
* operationId="getPetById",
* tags={"pet"},
* consumes={"application/json", "application/xml"},
* produces={"application/xml", "application/json"},
* @SWGParameter(
* description="ID of pet to return",
* in="path",
* name="petId",
* required=true,
* type="integer",
* format="int64"
* ),
* @SWGResponse(
* response=200,
* description="successful operation",
* @SWGSchema(ref="#/definitions/Pet")
* ),
* @SWGResponse(
* response="400",
* description="Invalid ID supplied"
* ),
* @SWGResponse(
* response="404",
* description="Pet not found"
* ),
* security={
* {"api_key": {}}
* }
* )
*/
Get:請(qǐng)求的 HTTP 方法,支持GET/POST/PUT/DELETE 等 HTTP 標(biāo)準(zhǔn)請(qǐng)求方法
path:請(qǐng)求的路徑
summary:接口簡(jiǎn)介,不能超過(guò)120個(gè)字符
tags:接口標(biāo)簽,可以是多個(gè)
description:接口描述,支持 Markdown 語(yǔ)法
operationId:操作的 ID,全局唯一的接口標(biāo)識(shí)
consumes:接口接收的MIME類型,如 application/json
produces:接口返回的MIME類型,如 application/json
parameters:參數(shù)列表
description:參數(shù)描述
in:參數(shù)從何處來(lái). 必填. 取值僅限: "query", "header", "path", "formData", "body"
name:參數(shù)名.
required:參數(shù)是否必須. 通過(guò)路徑傳參(in 取值 "path")時(shí)必須為 true.
type=參數(shù)類型. 取值僅限: "string", "number", "integer", "boolean", "array", "file"
format:參數(shù)格式,如"int64"
response: 描敘了來(lái)自API操作的單個(gè)響應(yīng)
response:返回碼
description=描述
@SWGSchema(ref="#/definitions/Pet"): 引用definitions/Pet定義的對(duì)象
4. 定義對(duì)象 5.type 為array的寫法</>復(fù)制代碼
文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址:http://m.specialneedsforspecialkids.com/yun/28495.html
摘要:中基于的自動(dòng)實(shí)體類構(gòu)建與接口文檔生成是筆者對(duì)于開(kāi)源項(xiàng)目的描述,對(duì)于不反感使用注解的項(xiàng)目中利用添加合適的實(shí)體類或者接口類注解,從而實(shí)現(xiàn)支持嵌套地實(shí)體類校驗(yàn)與生成等模型生成基于的接口文檔生成等等功能。 JavaScript 中基于 swagger-decorator 的自動(dòng)實(shí)體類構(gòu)建與 Swagger 接口文檔生成是筆者對(duì)于開(kāi)源項(xiàng)目 swagger-decorator 的描述,對(duì)于不反感使...
摘要:其標(biāo)準(zhǔn)為前身是,提供強(qiáng)大的在線編輯功能,包括語(yǔ)法高亮錯(cuò)誤提示自動(dòng)完成實(shí)時(shí)預(yù)覽,并且支持用戶以格式撰寫導(dǎo)入導(dǎo)出轉(zhuǎn)換文檔。 團(tuán)隊(duì)內(nèi)部RestAPI開(kāi)發(fā)采用設(shè)計(jì)驅(qū)動(dòng)開(kāi)發(fā)的模式,即使用API設(shè)計(jì)文檔解耦前端和后端的開(kāi)發(fā)過(guò)程,雙方只在聯(lián)調(diào)與測(cè)試時(shí)耦合。在實(shí)際開(kāi)發(fā)和與前端合作的過(guò)程中,受限于眾多因素的影響,開(kāi)發(fā)效率還有進(jìn)一步提高的空間。本文的目的是優(yōu)化工具鏈支持,減少一部分重復(fù)和枯燥的勞動(dòng)。 現(xiàn)狀...
摘要:接口管理工具大致分為線上工具和自建工具。安裝其他工具上面講的,不管是線上工具還是自建工具,都是接口集成工具,主要是為了提供數(shù)據(jù)功能。類似網(wǎng)易云筆記印象筆記的筆記管理工具。 api 接口管理工具 現(xiàn)在,Web 應(yīng)用的前后端分離事實(shí)上已經(jīng)成為了大家都認(rèn)可的一種開(kāi)發(fā)方式,前后端分離之后,前端與后端都用接口(api)來(lái)溝通,這就需要我們做好 API 接口管理,所以,這次來(lái)聊聊 API 接口管理...
摘要:接口管理工具大致分為線上工具和自建工具。安裝其他工具上面講的,不管是線上工具還是自建工具,都是接口集成工具,主要是為了提供數(shù)據(jù)功能。類似網(wǎng)易云筆記印象筆記的筆記管理工具。 api 接口管理工具 現(xiàn)在,Web 應(yīng)用的前后端分離事實(shí)上已經(jīng)成為了大家都認(rèn)可的一種開(kāi)發(fā)方式,前后端分離之后,前端與后端都用接口(api)來(lái)溝通,這就需要我們做好 API 接口管理,所以,這次來(lái)聊聊 API 接口管理...
摘要:部署到項(xiàng)目中可以下來(lái)也可以下載文件。解壓后把目錄下的目錄拷貝到下下的文件夾中,如新建。訪問(wèn)修改為自己的項(xiàng)目文件。找到,把修改為自己的,如,再次訪問(wèn)即可。但是并不存在,需要生成。如放在下的目錄,用于存放文件。 1. 部署swagger ui 到項(xiàng)目中: 可以Git下來(lái) git clone https://github.com/swagger-api/swagger-uiv也可以下載zi...
閱讀 1423·2021-10-08 10:04
閱讀 747·2021-09-07 09:58
閱讀 2926·2019-08-30 15:55
閱讀 2480·2019-08-29 17:21
閱讀 2182·2019-08-28 18:04
閱讀 3086·2019-08-28 17:57
閱讀 730·2019-08-26 11:46
閱讀 2269·2019-08-23 17:20
极致性价比!云服务器续费无忧!
Tesla A100/A800、Tesla V100S等多种GPU云主机特惠2折起,不限台数,续费同价。
NVIDIA RTX 40系,高性价比推理显卡,满足AI应用场景需要。
乌兰察布+上海青浦,满足东推西训AI场景需要