BrewCenter / BrewCenterAPI

An open source api for managing homebrewing related data.
32 stars 11 forks source link

Add documentation #48

Closed emman27 closed 7 years ago

emman27 commented 7 years ago

I've actually done 2 things here.

  1. Django Rest Swagger is added as a project dependency and the relevant views are available at /documentation. This should support your future development should you choose to go down the path of viewsets and routers, as recommended by rest_framework itself.

  2. I've also added a documentation.yaml file to your project - in the OpenAPI 3.0 format documenting your custom views, with data schemas which are rather extensible (I hope). This should also support your needs if you decide for something more customized.

Resolves #29

emman27 commented 7 years ago

Silly me forgot about the October 1st startdate >< Will put this in again tomorrow!