search

vpmalley / jetlag

Bases of a future travel blog platform
MIT License
1 stars 0 forks source link

Add an API documentation #61

Open Vallenain opened 7 years ago

Vallenain commented 7 years ago

Having the routes is pretty cool, it'd be even coolier to have a full description of what our API endpoints expect and return (maybe we can directly reference the .raml files if we keep with it).

I've checked two tools (really quickly):

vpmalley commented 7 years ago

We already have the first lib (laravel-apidoc-generator) and it is accessible through http://homestead.app/routes. It is not very detailed though, we should probably look into improving it with the docbllocks