mermade/openapi-gui

OpenAPI-GUI镜像说明

镜像概述

OpenAPI-GUI是一款轻量级可视化工具，专注于简化OpenAPI（原Swagger）定义文件的创建与编辑流程。它提供直观的图形界面，帮助开发者快速生成符合规范的API文档，降低手动编写JSON/YAML的复杂度。

核心功能

• 支持OpenAPI 3.0.x版本的JSON/YAML定义创建与编辑
• 自动将导入的OpenAPI 2.0版本定义转换为3.0版本
• 可视化界面简化API结构（路径、参数、响应等）的配置

使用场景

• 快速启动简单API的OpenAPI文档编写
• 编辑已有的OpenAPI定义文件
• 将旧版Swagger（2.0）文档升级至OpenAPI 3.0标准

配置说明

无需额外配置，通过Docker容器即可直接运行使用。

部署示例

Docker Run命令

bash
docker run -d -p 8080:80 --name openapi-gui mermade/openapi-gui

运行后访问http://localhost:8080即可使用编辑器。

Docker Compose示例

yaml
version: '3'
services:
  openapi-gui:
    image: mermade/openapi-gui
    ports:
      - "8080:80"
    restart: always

执行docker-compose up -d启动服务。