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

Hil*_*ill 5 api documentation swagger swagger-editor

我已经开始使用ReDoc来发布我的文档,但是在将其推送到Web服务器之前并没有很好的方法来知道它的外观。我过去使用过http://editor.swagger.io/,发现它非常有用。ReDoc有类似的东西吗?

Dom*_*ino 5

是的,如果您使用此项目: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

或者,只需运行 docker-compose up 即可使用 Docker。