swagger-local-editor

This project demonstrates using express server to host swagger editor to view and edit OpenAPI specifications (that is also hosted by the same express server).

Usage

npm install
npm start

The follow the prompt and open browser to http://localhost:8080/editor/?url=/specs/myapi.yaml

Features

The setup supports referencing definitions across files by relative path. Either:

• referencing an element in another file (see myapi.yaml -> definitions.yaml)
• referencing the entire file (see myapi.yaml -> pets.yaml -> pet.yaml)

Technical Detail

The specifications is served at /specs/*, which maps to local ./specs folder and provides GET and PUT methods for retrieving and updating the local files.

The editor is served at /editor/ with most of the assets from the swagger-editor-dist package. The only customisation is the index.html page, which is based on the default with a custom plugin that issues PUT request to the URL whenever the spec is changed.

Disclaimer

This project is for demostration purpose only and is by no means production ready.