koumoul/openapi-viewer

OpenAPI 3 查看器

本服务用于轻松浏览和测试符合https://github.com/OAI/OpenAPI-Specification%EF%BC%88%E5%8E%9FSwagger%E8%A7%84%E8%8C%83%EF%BC%89%E7%9A%84REST API，主要基于https://github.com/koumoul-dev/vue-openapi%E7%BB%84%E4%BB%B6%E5%BC%80%E5%8F%91%EF%BC%8C%E5%B9%B6%E6%8F%90%E4%BE%9BNodeJS%E5%90%8E%E7%AB%AF%E4%BB%A3%E7%90%86%E5%8A%9F%E8%83%BD%E3%80%82

在线演示：

• [***]

镜像概述

该镜像封装了OpenAPI 3查看器服务，支持直接加载API文档并进行接口测试，同时提供代理功能解决跨域资源共享（CORS）限制，方便在不同环境下访问API文档。

核心功能

• 浏览符合OpenAPI 3.0规范的REST API文档结构
• 在界面中直接发起API测试请求并查看响应
• 提供代理功能，解决API文档跨域访问问题
• 通过查询参数预填API地址、请求头、查询参数等配置
• 支持隐藏工具栏，适配iframe集成场景

使用场景

• 开发人员快速查看和测试自有或第三方OpenAPI 3.0接口
• 团队内部共享API文档并协作验证接口功能
• 集成到项目中作为API文档展示与测试工具

配置说明

Docker部署示例

Docker Run命令

bash
docker run -p 8080:8080 koumoul/openapi-viewer

部署后访问：http://localhost:8080/

查询参数说明

可通过URL查询参数预配置查看器：

• url：API文档文件地址（需为OpenAPI v3 JSON格式）
• proxy：是否使用后端代理获取文档（true/false，默认false；本地文档无需使用）
• headers：URI编码的JSON对象，预填请求头（如x-api-key、authorization）
• query-params：URI编码的JSON对象，预填查询参数（如多租户应用的organizationId）
• hide-toolbar：是否隐藏工具栏（true/false，默认false，适合iframe嵌入）