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

Create a Swagger description of the REST API #435

Closed
osma opened this issue Jan 20, 2016 · 3 comments
Closed

Create a Swagger description of the REST API #435

osma opened this issue Jan 20, 2016 · 3 comments
Labels
enhancement needs documentation REST size-large more than 2 days
Milestone
1.7

Comments

@osma
Copy link
Member

osma commented Jan 20, 2016

We could replace or complement the current REST API documentation using Swagger:
http://swagger.io/getting-started/

A possible way of doing this is using Swagger-PHP annotations:
http://zircote.com/swagger-php/

This would make the REST API much easier to approach and play with. Also implementors might be able to autogenerate client side code from the Swagger description.
@osma osma added this to the Next Tasks milestone Jan 20, 2016
@osma osma modified the milestones: Next Tasks, 1.7 Feb 16, 2016
@osma osma added the size-large more than 2 days label Feb 16, 2016
osma added a commit that referenced this issue May 10, 2016
@osma
Initial stub for Swagger description of REST API. Part of #435
59a6d7b
@osma
Copy link
Member Author

osma commented May 11, 2016

Installed Swagger-UI so it's visible at http://api.dev.finto.fi/doc/ , still needs more customization etc.

@osma
Copy link
Member Author

osma commented May 12, 2016

We could also add a "valid Swagger" badge to the github front page...
https://github.com/swagger-api/validator-badge

osma added a commit that referenced this issue Jun 20, 2016
@osma
Don't hardcode hostname in Swagger description. Related to #435
14d017a
@osma
Copy link
Member Author

osma commented Jun 20, 2016

All done.

@osma osma closed this as completed Jun 20, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement needs documentation REST size-large more than 2 days
Projects
None yet
Milestone
1.7
Development

No branches or pull requests
1 participant
@osma