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规范支持的当前状态。