Swagger Editor

发表于 更新于 分类于

概述

Swagger Editor 能够让你在YAML文件里编辑Swagger API规格说明书，并且能够在你的浏览器实时的预览文档内容。能够使用Swagger工具自动生成一些有效的JSON文档描述，还可以生成代码。

在线例子

Screenshot of the Swagger Editor

Docker环境运行

这个 swagger-editor 已经在Dockerhub上的公有仓库中发布了。
你可以很容易的在docker中运行editor：

1
2
docker pull swaggerapi/swagger-editor
docker run -p 80:8080 swaggerapi/swagger-editor

本机环境运行

下载最后一个稳定版本(v2.10.4)并且可以通过访问你的HTTP server访问静态静态文件内容 .如果你没有HTTP server,你可以使用Node.js 提供的http-server模块。

使用http-server模块：

1
2
3
4
npm install -g http-server
wget https://github.com/swagger-api/swagger-editor/releases/download/v2.10.4/swagger-editor.zip
unzip swagger-editor.zip
http-server swagger-editor

构建源码

确保你的电脑安装了Node.js.

1
2
3
4
git clone https://github.com/swagger-api/swagger-editor.git
cd swagger-editor
npm install
npm start

文档

贡献

LICENSE