Skip to content

Integrate swagger for API documentation #15

@devcbuea

Description

@devcbuea

**Is your feature request related to a problem?
As of now there is no proper documentation of the api service ,this makes it difficult for people who want to contribute and also will mean people contributing to the web or mobile client have to refer to the server code for api endpoints and possibly what the format of response

Describe the solution you'd like
UsinOpenAPI specification with swagger to create proper documentation for api endpoints.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
https://github.com/OAI/OpenAPI-Specification
https://idratherbewriting.com/learnapidoc/pubapis_openapi_tutorial_overview.html
https://swagger.io/solutions/api-documentation/

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions