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

Setup Swagger for documentation #66

Open
bk1713 opened this issue Nov 15, 2017 · 0 comments
Open

Setup Swagger for documentation #66

bk1713 opened this issue Nov 15, 2017 · 0 comments
Assignees
@sfloam @cfnyu @Harivadhana
Labels
new feature Pair Programmed
Milestone
Sprint 4 - Comple...

Comments

@bk1713
Copy link
Collaborator

bk1713 commented Nov 15, 2017 •
edited by cfnyu
Loading

As a ... developer
I need ... to setup Swagger with RESTPlus plugin
So that ... we can include documentation for each of our API calls

Assumptions:

  • There is an API for CRUD and and Action
  • A namespace must be created
  • An API model must be defined
  • The import statement should be from flask_restplus import Api, Resource, fields

Acceptance Criteria:

Given RestPlus is configured 
When I import flask_restplus
Then I shouldn't have any compile errors
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sfloam sfloam

@cfnyu cfnyu

@Harivadhana Harivadhana

Labels
new feature Pair Programmed
Projects
None yet
Milestone
Sprint 4 - Complete homework 2
Development

No branches or pull requests
4 participants
@sfloam @cfnyu @bk1713 @Harivadhana