ReDoc是否有类似于Swagger编辑器的实时编辑器?

时间:2017-11-02 23:27:21

标签: api documentation swagger swagger-editor

我已经开始使用ReDoc发布我的文档,但是在将其推送到我的Web服务器之前,没有一个好方法可以知道它会是什么样子。我过去曾使用http://editor.swagger.io/,发现它非常有用。 ReDoc有类似的东西吗?

1 个答案:

答案 0 :(得分:2)

是的,如果您使用此项目:https://github.com/Rebilly/generator-openapi-repo#features

您可以使用swagger编辑器。它不会呈现ReDoc的预览,但您可以运行本地开发环境并观察该浏览器窗口的重新加载。要启动本地开发环境,请参阅此处的说明https://github.com/rebilly/Redoc#development

运行本地开发服务器

  1. 克隆存储库git clone https://github.com/Rebilly/ReDoc.git
  2. 转到项目文件夹cd ReDoc
  3. 安装依赖项npm install
  4. (可选)将demo / swagger.yaml替换为您自己的架构
  5. 启动服务器npm start
  6. 打开http://localhost:9000
  7. 或者,只需运行docker-compose up即可使用Docker。