cablelabs / lpwanserver

LPWAN Provisioning & Management Server
https://lpwanserver.com
Apache License 2.0
37 stars 11 forks source link

OpenAPI-based live swagger docs #329

Closed rhythnic closed 5 years ago

rhythnic commented 5 years ago

Serve the REST API docs at the /api endpoint, using Swagger-UI

rhythnic commented 5 years ago

Web-component that renders swagger-like docs for an OpenAPI file. No need to generate docs. https://mrin9.github.io/RapiDoc/

rhythnic commented 5 years ago

Redoc has the same easy usage flow as RapiDoc. I'm using speccy to build the OpenAPI file from partials. The speccy CLI uses redoc to serve the REST docs locally, so it would be more consistent to use redoc on the docs site too.