Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Does ReDoc have a live editor similar to the Swagger Editor? [closed]

I've started using ReDoc to publish my documentation but don't have a good way to know what it will look like before pushing it to my web server. I've used http://editor.swagger.io/ in the past and found it pretty useful. Is there anything like that for ReDoc?

like image 675
Hill Avatar asked Nov 02 '17 23:11

Hill


People also ask

What is Swagger Redoc?

Redoc is an open-source tool that generates API documentation from OpenAPI specifications. Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate documentation from a Swagger-compliant API. Websites tracked. 1,500.

Is Redoc free to use?

Redoc is an open-source tool that generates API documentation from OpenAPI specifications. It's one of the most powerful free docs tools in the industry, producing clean, customizable documentation with an attractive three-panel design.

Is Redoc open-source?

Redoc is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions. By default Redoc offers a three-panel, responsive layout: The left panel contains a search bar and navigation menu.


1 Answers

Yes, if you use this project: https://github.com/Rebilly/generator-openapi-repo#features

You can use the swagger editor with it. It doesn't render a preview of ReDoc, but you can have a local dev environment running and watch that browser window reload. To start a local dev environment, see instructions from here https://github.com/rebilly/Redoc#development

Running local dev-server

  1. Clone repository git clone https://github.com/Rebilly/ReDoc.git
  2. Go to the project folder cd ReDoc
  3. Install dependencies npm install
  4. (optional) Replace demo/swagger.yaml with your own schema
  5. Start the server npm start
  6. Open http://localhost:9000

Alternatively, Docker can be used by just running docker-compose up.

like image 174
Domino Avatar answered Oct 20 '22 01:10

Domino