Part 4: Add Swagger documentation to document the API

pranaypareek commented 6 years ago

As a developer

I need Swagger documentation for our API service

So that other developers can look up how to use our API

Assumptions:

All API routes are working

Acceptance Criteria:

Given that all API routes are working
When I interact with each API route on the Swagger UI
Then each interaction (GET PUT POST DELETE etc) should be successful

Template from here (https://github.com/nyu-devops/lab-flask-swagger)
And instructions from here (https://newclasses.nyu.edu/access/content/group/a187e6ea-d539-4380-a829-eee7a4720c5e/09-OpenAPI-Swagger.pdf)

To keep things manageable, this issue can and should be broken down into smaller steps (we can create more stories if needed).

Add Swagger docs to your service to document your API using flasgger or Flask-RESTPlus as shown in class. The documentation API must be at: /apidocs/index.html

kqg13 commented 6 years ago

Update server.py to incorporate swagger

pranaypareek commented 6 years ago

Swagger's up.

NYU-Shopcarts / shopcarts

Part 4: Add Swagger documentation to document the API #60