https://github.com/etiennemarais/go-openapi-swag-ui-demo
SwaggerUI demo of swagger/openapi specification documentation that gets generated in other repositories using Github Actions.
https://github.com/etiennemarais/go-openapi-swag-ui-demo
living-documentation swagger swaggerui webpack
Last synced: 7 months ago
JSON representation
SwaggerUI demo of swagger/openapi specification documentation that gets generated in other repositories using Github Actions.
- Host: GitHub
- URL: https://github.com/etiennemarais/go-openapi-swag-ui-demo
- Owner: etiennemarais
- Created: 2021-02-23T09:05:27.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-08T14:32:31.000Z (over 4 years ago)
- Last Synced: 2025-01-17T19:44:22.094Z (9 months ago)
- Topics: living-documentation, swagger, swaggerui, webpack
- Language: JavaScript
- Homepage: https://vigilant-kepler-02cd3c.netlify.app/
- Size: 93.8 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# 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](https://github.com/etiennemarais/go-openapi-swag-demo) 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](https://vigilant-kepler-02cd3c.netlify.app)
