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

API documentation #33

Closed
AuHau opened this issue Jul 19, 2016 · 2 comments
Closed

API documentation #33

AuHau opened this issue Jul 19, 2016 · 2 comments

Comments

@AuHau
Copy link
Collaborator

AuHau commented Jul 19, 2016

Hey there,

I would suggest to create API documentation for example with https://apiary.io/. I used it on one of my projects and it is quiet nice way how to document and also test API (example from my project: http://docs.icalian.apiary.io/ ).

I want to work on the #6 issue so I will try to make the documentation after I will be finished.
@nicbou
Copy link
Owner

nicbou commented Jul 20, 2016

The API is a simple REST API. Since it doesn't have any external user, I don't think it would be really useful

@nicbou nicbou closed this as completed Jul 20, 2016
@AuHau
Copy link
Collaborator Author

AuHau commented Jul 20, 2016

Ok if you think so.
Maybe it would be useful for people who would like to contribute, because at least so far I have not figured out how to easily find the routes for the API (you have to know how Tastypie works and how to derive the routes from the Resources name)...

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
@nicbou @AuHau