openapi

    0熱度

    1回答

    我使用ReDoc來使用OpenAPI 2(Swagger)JSON文件可視化API文檔。我試圖通過包括第一模式到第二個如下聲明兩個請求輸入參數: ... "definitions": { "list-request": { "type": "object", "properties": { "token":{ "type": "st

    1熱度

    1回答

    我們正在使用Swagger從源代碼生成API文檔。我現在想知道是否有任何工具會自動檢查生成的OpenAPI文檔(= Swagger JSON)與RESTful API設計最佳實踐的符合性。 例如Zalando已經在這些準則所定義的REST設計一個公開的指導方針在我看來有可自動檢查基礎上,OpenAPI的規格很多規則: 「不要向後打破兼容性「可以在不同版本的OpenAPI 文件進行比較時進行檢查。

    4熱度

    1回答

    我使用揚鞭OpenAPI的規格工具,我有一個字符串數組屬性中的定義之一如下: cities: type: array items: type: string example: "Pune" 我的API產生JSON結果因此對於下面的結果上述對象出現在響應: { "cities": [ "Pune" ] } 試

    3熱度

    1回答

    的Java /春服務器存根生成與招搖,CODEGEN - Maven的插件 在我的春天啓動的Java項目,我使用swagger-codegen-maven-plugin產生從我揚鞭2.0 API的Spring MVC的控制器接口(服務器存根)。陽明海運。 Maven構建過程中的集成非常簡單。它的工作原理與我以前用WSAX的jaxws-maven插件完成的一樣。這是使用swagger-codegen

    1熱度

    1回答

    假設我有一個YAML的OpenAPI定義 definitions: User: description: "User" type: "object" properties: firstname: type: "string" lastname: type: "string" password:

    1熱度

    1回答

    我目前正在使用Swagger Editor(v3.1.9)和Open API 3規範開發API規範。 我得到一些特殊的行爲專門爲架構組件我有一個名爲Comment Comment: description: "A comment on an asset or submission" allOf: - $ref: "#/components/schemas/Messag

    0熱度

    1回答

    我可以成功將以下OpenAPI定義導入到Azure API管理中。 但是,當我導出OpenAPI定義時,「架構」名稱已從「響應」對象中刪除。因此,我的門戶中的開發人員未顯示此操作的架構或示例。 如果將我的API定義添加到the official editor,那麼我的API定義是有效的並且功能正確。 如何防止模式被剝離? { "swagger": "2.0", "info":

    1熱度

    1回答

    我正在使用Swagger處理OpenAPI中的模式,並且我不確定是否濫用了$ref元素。我有一個User模型和Project模型,類似於像 User: type: object properties: id: type: string format: uuid name: type: string

    1熱度

    1回答

    我想爲我的Swagger API創建遞歸規範。這個概念似乎從the Swagger documentation缺席,所以我懷疑這是不可能的。所以我也願意接受Swagger支持的其他解決方案。 例如,我試圖創建一個類似文檔的結構。每個文檔都有部分,每個部分都有文本和它自己的部分。 我打算在具有API端點這樣的: http://a.b.com/docs/ {文檔ID} http://a.b.com/d

    1熱度

    1回答

    有沒有在請求正文中編寫多行示例的方法?如果可能的話,我希望我的OpenApi文檔在Swagger-UI下運行時顯示如下。 到目前爲止,我已經能夠做到的,是一個單行例子,如下所示: