https://github.com/etiennemarais/go-openapi-swag-demo

A typical micro service that serves a JSON api to a set of clients somewhere. It uses Swag to generate the swagger/openapi compliant specs and then on main push will ship the generated file to the UI repo to get auto published for your team to have living documentation
https://github.com/etiennemarais/go-openapi-swag-demo

api-docs-generator api-documentation go golang living-documentation micro-service swagger

Last synced: about 5 hours ago
JSON representation

A typical micro service that serves a JSON api to a set of clients somewhere. It uses Swag to generate the swagger/openapi compliant specs and then on main push will ship the generated file to the UI repo to get auto published for your team to have living documentation

• Host: GitHub
• URL: https://github.com/etiennemarais/go-openapi-swag-demo
• Owner: etiennemarais
• License: mit
• Created: 2021-02-18T13:06:28.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-03-08T14:18:41.000Z (over 3 years ago)
• Last Synced: 2024-06-19T05:29:58.367Z (5 months ago)
• Topics: api-docs-generator, api-documentation, go, golang, living-documentation, micro-service, swagger
• Language: Go
• Homepage: https://github.com/etiennemarais/go-openapi-swag-ui-demo
• Size: 11.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# go-openapi-swag-demo

![Api Docs](https://github.com/overhq/etiennemarais/go-openapi-swag-demo/Swagger/badge.svg)

## Summary

Trying to write documentation by hand is a tedious ask. This optimizes writing documentation for the writer as close to the code as possible by using annotations

to auto generate api docs.

Ths issue with most outputs are that it would just live in a file somewhere and that sucks. By leveraging github actions and a little magic, we can send the generated file to a [repo that auto builds and deploys](https://github.com/etiennemarais/go-openapi-swag-ui-demo) the documentation making it more up to date.