Auto swagger-docs with swagger-ui-react and swagger-jsdocs.

vanvalenlab / kiosk-frontend

DeepCell web application built using NodeJS, Express, React, and Webpack.

Other

1 stars 0 forks source link

Auto swagger-docs with swagger-ui-react and swagger-jsdocs. #110

Closed willgraf closed 4 years ago

willgraf commented 4 years ago

Swagger Docs are a great way to document APIs. This PR uses swagger-jsdocs to generate a Swagger JSON spec from decorated jsdocs on the API routes. This JSON spec is served over /api/swagger.json. The frontend react app uses the sagger-ui-react's SwaggerUI component to consume that JSON endpoint and generate the documentation page.

Fixes #97