Polypheny-DB icon indicating copy to clipboard operation
Polypheny-DB copied to clipboard

Adding Swagger to the backend

Open muaz-32 opened this issue 11 months ago • 0 comments

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 avatar Mar 14 '24 17:03 muaz-32