openapi gui

Openapi-gui

OpenAPI-GUI是用於創建和編輯OpenAPI版本3.0.X JSON/YAML定義的GUI。在當前形式中，最有用的是開始和編輯簡單的OpenAPI定義的工具。導入的OpenAPI 2.0定義會自動轉換為v3.0。

有關以前的Swagger / OpenAPI 2.0版本，請參見此處。該版本目前是不太好的，除了安全修復。

該項目最初是達里爾·庫恩（Daryl Kuhn）的iodoctor的叉子，而布蘭登·韋斯特（Brandon West）則受到iodoctor的啟發。該項目的完整歷史記錄在Github上。

描述

它如何工作

選擇現有的OpenAPI 2.0或3.0.X定義以上傳，或創建新的定義，然後開始添加路徑，操作和參數。當使用現有定義時，將解析並為編輯每個路徑，操作和參數編輯形式。

您可以通過附加a ?url=查詢參數加載到初始啟動頁面上，其中值是要加載的定義的URL。使用Docker時，您可以將url查詢參數的值設置為%2fserve ，以拾取您在Docker Commandline上傳遞的定義。

單擊左側菜單中的項目以開始編輯。通過選擇一個“導出”選項卡，隨時查看JSON/YAML輸出。完成後，下載輸出以在本地保存或將其複制您的剪貼板。 OpenAPI-GUI一次僅存儲一個定義，這在您的瀏覽器本地存儲中。確保在本地保存JSON/YAML輸出。

在執行破壞性動作之前，OpenAPI-GUI保存了定義的當前狀態。在其他時間，您必須記住手動選擇保存。

技術

OpenAPI-GUI完全使用許多JavaScript框架運行，包括VUE.JS，JQUERY和BULMA的CSS。

要使應用程序啟動並運行，只需瀏覽github頁面上的實時版本，請將克隆部署到github頁面，使用下面的按鈕部署到Heroku，或克隆倉庫，然後將瀏覽器指向index.html或託管它，或者您自己託管 - 不太簡單。這裡更多的技術信息。

如果您希望使用openapi-gui嵌入式Web服務器（即如果您正在運行自己的Web服務器），則只需要npm install 。

CLI選項

 -d, --definition    serve the given OAS definition
-l, --launch        start a web-browser pointing to the GUI
-p, --port          specify the port to run on, defaults to $PORT or 3000
-w, --write         enable writing back to the source definition

與Docker一起跑步

如果您沒有本地節點開發環境，或者您希望在Docker容器中運行OpenAPI-GUI，則可以通過幾個簡單的步驟進行操作：

1. 克隆存儲庫。
2. 運行docker build -t mermade/openapi-gui .構建Docker圖像（ mermade/openapi-gui ）
3. 運行docker run --name openapi-gui -p 8080:3000 -d mermade/openapi-gui在端口8080上運行服務器。
4. 導航到您喜歡的瀏覽器中的http://localhost:8080 。
5. 完成後，通過運行docker stop openapi-gui && docker rm openapi-gui關閉服務器

或者，您可以拉動預製的Docker映像：

• docker pull mermade/openapi-gui

限制

• OpenAPI-GUI將退還共享參數。
• 該定義必須在沒有外部$ref s的情況下獨立。這很可能很快就可以解決（Ho-Ho） 。
• 編輯響應 /示例 /身體架構將放棄它。
• OpenAPI-GUI不會始終保留供應商 - 如果刪除和重新創建參數。
• OpenAPI-GUI不會從YAML格式導入的定義中保留評論。

托多

• 請參閱todo列表和OpenAPI 3.0規範支持的當前狀態。