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

Adding Swagger to the backend #478

Open
muaz-32 opened this issue Mar 14, 2024 · 0 comments
Open

Adding Swagger to the backend #478

muaz-32 opened this issue Mar 14, 2024 · 0 comments
Labels
C-enhancement Category: An issue proposing an enhancement

Comments

@muaz-32
Copy link

muaz-32 commented Mar 14, 2024

Affected Areas

Control, Something else (please specify in the description!)

Feature Description

As developers need to know the API endpoints and their formats, I think it is necessary to implement an API specification like Swagger for the backend.

Use Case(s)

Developers frequently need to access the API, test them, and know the format of the requests. This is important for both the backend and the front end. Swagger will help the devs to easily get this done as it contains a standard specification for the APIs. When creating new APIs, swagger will automatically generate specifications for them. As a result, the devs will not need to dig into the backend code to figure out the request and response formats.

Possible Solutions

No response

Possible Alternatives

No response

@muaz-32 muaz-32 added the C-enhancement Category: An issue proposing an enhancement label Mar 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: An issue proposing an enhancement
Projects
None yet
Development

No branches or pull requests

1 participant