Add OpenAPI to support creating API documentation with OpenAPI
suho opened this issue · comments
Why
The team now has OpenAPI Training Path to learn and practice. OpenAPI on Compass for developers to follow conventions and best practices. NO OpenAPI boilerplates currently exist in the gin templates to support web developers in creating API documentation with OpenAPI.
Acceptance Criteria
- Add OpenAPI addon as an optional addon in the template.
- Add OpenAPI tooling (Spectral, Elements, Lint).
- Create an endpoint (e.g.,
GET {{base_url}}/api/docs/openapi) to access the API documentation through the browser. - Add Mock Server with Prims (related to this API Mock Server with OpenAPI).
- Add CI/CD workflow to run linting and deploy mock server to fly.io.
Resources
- Add OpenAPI to Web templates
- nimblehq/api-mock-templates#3
- https://github.com/nimblehq/nimble-survey-web
Who Benefits?
Everyone
@suho Could you help recheck the OpenAPI Training Path link? I got a 404 page, not sure if it's because I don't have enough permission or the link is broken 🙏🏼