elixir-templates icon indicating copy to clipboard operation
elixir-templates copied to clipboard

Add OpenAPI to support creating API documentation with OpenAPI

Open suho opened this issue 1 year ago • 2 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 elixir templates to support web developers in creating API documentation with OpenAPI.

Acceptance Criteria

  • Only add OpenAPI when create API template (--api)
  • Add OpenAPI addon as a required 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 CI workflow to run linting
  • Add Mock Server with Prims (related to this API Mock Server with OpenAPI) as an optional add-on.
  • Add CD workflow to deploy mock server to fly.io if the developer select mock server add-on.

Resources

Who Benefits?

Everyone

suho avatar Jul 25 '23 09:07 suho

@suho could you update the link for OpenAPI Training Path as the current link show 404 page

image

andyduong1920 avatar Jul 26 '23 02:07 andyduong1920

@andyduong1920 Sorry for the late, I updated the link

suho avatar Aug 10 '23 08:08 suho