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

Need to improve Swagger Documentation #7

Open
ZiaCodes opened this issue Oct 18, 2023 · 2 comments
Open

Need to improve Swagger Documentation #7

ZiaCodes opened this issue Oct 18, 2023 · 2 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest for hacktoberfest 2023 hacktoberfest2023 Hacktoberfest-accepted

Comments

@ZiaCodes
Copy link
Owner

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

@ZiaCodes ZiaCodes added enhancement New feature or request good first issue Good for newcomers hacktoberfest for hacktoberfest 2023 hacktoberfest2023 Hacktoberfest-accepted labels Oct 18, 2023
@Sadman95
Copy link
Contributor

Hello
I want to contribute. Assign me.

@ZiaCodes
Copy link
Owner Author

Hello I want to contribute. Assign me.

Okay go ahead , fork the repo and let me know if you need any help ?

reach out to me in case of any help - [email protected]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest for hacktoberfest 2023 hacktoberfest2023 Hacktoberfest-accepted
Projects
None yet
Development

No branches or pull requests

2 participants