Skip to content

Need to improve Swagger Documentation  #7

@ZiaCodes

Description

@ZiaCodes

Swagger API Documentation need to improve

What is Swagger ?
Swagger allows you to describe the structure of your APIs so that machines can read them. The ability of APIs to describe their own structure is the root of all awesomeness in Swagger.

Find more about swagger UI - https://swagger.io/solutions/api-documentation/

Your Task :
I have already integrated Swagger UI , you don't have to configure anything , your task is to add every APIs routes that are available from Yogavaar backend.
define response and invalid response as well.

If you clone the repo and run it locally , you can see the swagger UI in this route - http://localhost:8000/yogavar-swagger/api-docs/

How to work ?

  • Clone the repository

git clone repo-link

  • Make a new Branch

git branch feature-branch

  • work on backend\swaggerApi dic only

  • push it and open a pull request

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions