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

enhancement(phoenix): Document api #73

Open
mrapacz opened this issue Aug 15, 2017 · 0 comments
Open

enhancement(phoenix): Document api #73

mrapacz opened this issue Aug 15, 2017 · 0 comments

Comments

@mrapacz
Copy link
Collaborator

mrapacz commented Aug 15, 2017

Type

Enhancement

Current behaviour

Right now we have no documentation saying what our backend endpoint return.

Expected behaviour

It would be pretty useful and easier to maintain if we knew what the endpoints should return.

We could use Swagger for that. Here's a lib that integrates Swagger with Phoenix, check it out.

Motivation / use case
Let's make our codebase easier to maintain and easier to extend.

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

1 participant