Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add OpenAPI to support creating API documentation with OpenAPI #328

Open
suho opened this issue Jul 25, 2023 · 2 comments
Open

Add OpenAPI to support creating API documentation with OpenAPI #328

suho opened this issue Jul 25, 2023 · 2 comments
Assignees

Comments

@suho
Copy link
Member

suho commented Jul 25, 2023

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 suho self-assigned this Jul 25, 2023
@andyduong1920
Copy link
Member

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

image

@suho
Copy link
Member Author

suho commented Aug 10, 2023

@andyduong1920 Sorry for the late, I updated the link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants