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

Rest API design #6

Closed
tanerochris opened this issue May 1, 2020 · 1 comment · Fixed by #19
Closed

Rest API design #6

tanerochris opened this issue May 1, 2020 · 1 comment · Fixed by #19
Assignees
@tanerochris
Labels
design design interface, api, schema
Milestone
Sprint-2

Comments

@tanerochris
Copy link
Contributor

  • Come out with endpoints for the project
  • Use the open API v3.0.0 specification
  • Make use of platforms that can export the API docs to pdf, Html, yuml or JSON
  • You can check out the following platforms ​swagger,​ open-api gu
  • Make use of schemas designed in ​ Schema/Model design #3
  • In case of doubts please post in the group
@tanerochris tanerochris added the enhancement New feature or request label May 1, 2020
@tanerochris tanerochris added the design design interface, api, schema label May 1, 2020
@tanerochris tanerochris added this to the sprint-1 milestone May 1, 2020
@tanerochris tanerochris removed the enhancement New feature or request label May 1, 2020
@tanerochris tanerochris assigned tanerochris and unassigned ndounalex May 5, 2020
@tanerochris
Copy link
Contributor Author

Issue reassigned to @tanerochris

tanerochris added a commit that referenced this issue May 10, 2020
@tanerochris
6-docs(): Api design documentation
9c65046 
OpenAPI 3.0 design
Yaml and JSON files

closes #6
@tanerochris tanerochris mentioned this issue May 10, 2020
Merged
6 tasks
@tanerochris tanerochris modified the milestones: sprint-1, sprint-2 May 10, 2020
mernxl pushed a commit that referenced this issue May 20, 2020
@tanerochris @mernxl
6-docs(): Api design documentation
d61a0a8 
OpenAPI 3.0 design
Yaml and JSON files

closes #6
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tanerochris tanerochris

Labels
design design interface, api, schema
Projects
None yet
Milestone
Sprint-2
Development

Successfully merging a pull request may close this issue.

#37405551-docs(): Api design documentation BuildForSDG/voxnostra
2 participants
@tanerochris @ndounalex