Skip to content

SwaggerUI demo of swagger/openapi specification documentation that gets generated in other repositories using Github Actions.

Notifications You must be signed in to change notification settings

etiennemarais/go-openapi-swag-ui-demo

Repository files navigation

Swagger UI Demo

This project aims to demo how a webpack based build of the swagger UI projects works. This UI auto builds to netlify and loads the relevant services yaml files into the scope of the documentation. The added features here are that the output files get generated from somewhere else entirely and get pushed to this repo as a single source of truth.

Netlify will pick up the change, build it and ship it so that it is viewable by someone on your team. This should take a little bit of the sting out of having living documentation in your engineering team and supports multi-service, multi-language api documentation as long as it generates swagger or openapi specifications.

Demo

Viewable on Netlify

Screenshot

About

SwaggerUI demo of swagger/openapi specification documentation that gets generated in other repositories using Github Actions.

Topics

Resources

Stars

Watchers

Forks