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.

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

Swagger #2

Open
cameronjacoby opened this issue Nov 3, 2015 · 2 comments
Open

Swagger #2

cameronjacoby opened this issue Nov 3, 2015 · 2 comments

Comments

@cameronjacoby
Copy link
Contributor

Better documentation with http://swagger.io

@eerwitt
Copy link
Contributor

eerwitt commented Nov 3, 2015

Added in an initial usage of Swagger on: https://github.com/sf-wdi-24/crud-api/compare/swagger

Most changes are on server.js but also added in swaggerui.

I set the model definition on GET /books/ to return an Object instead of an Array which is a common practice to support additional information about the result set.

Is it OK if we change the responses for the listing to be an object with an element for "results" or "books"?

screen shot 2015-11-03 at 10 49 20 am

While looking over it, I think if someone is first starting out seeing all this information is overwhelming!

@cameronjacoby
Copy link
Contributor Author

Just recapping what @eerwitt and I talked about earlier. This is a really awesome start for getting us up and running with Swagger, but we won't finish implementing it for week 3, since the API is in a working state for our lessons, and we should focus on lesson planning instead.

It can be an ongoing effort to implement swagger, so we'll leave this issue and the branch open for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants