Add Swagger annotations

[nyu-kaitlyn]

As a developer I need to add Swagger annotations to my API endpoints So that other developers can easily understand the purpose and functionality of my API endpoints

Details and Assumptions

• The API has already been developed and is ready to be documented using Swagger annotations

  Acceptance Criteria

  Given an existing API with multiple endpoints
  When I use Swagger annotations to document each endpoint with details such as description, parameter types, response types, and error codes
  Then other developers can easily understand how to use the API, what parameters to pass, and what responses to expect, resulting in reduced confusion and errors in API usage and development

[nyu-kaitlyn]

More detail:

• Add Swagger annotations to your service to document your REST API using Flask-RESTX as shown in class.
• The documentation API must be available at: /apidocs/