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.

Sign up for GitHub

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

Jump to bottom

Better API documentation using phoenix_swagger #116

Closed
jakobwgnr opened this issue Dec 9, 2018 · 2 comments
Closed

Better API documentation using phoenix_swagger #116

jakobwgnr opened this issue Dec 9, 2018 · 2 comments

Comments

@jakobwgnr
Copy link
Contributor

Just an idea:
Currently the RIG API is only documented in the guides docs. We could used phoenix_swagger instead (See Github Repo)

It seems to be rather easy to implement: How-To Article

Advantages:

  • Documentation as code
  • Autogenerated swagger.json file
  • Hosting of swagger-ui via endpoint
  • testing possibilities against Schemas for requests/responses
@kevinbader
Copy link
Contributor

+1
This is definitely something we need.

@kevinbader
Copy link
Contributor

merged with f7e855b

@snyk-bot snyk-bot mentioned this issue Nov 28, 2021
Open
@steveoliver steveoliver mentioned this issue Oct 5, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kevinbader @jakobwgnr