Skip to content

feat: OpenAPI documentation #9

@VikashKothary

Description

@VikashKothary
  • WHY: This will read the Django project and display interactive documentation on how to use the API minimising the barrier to entry for developing on top of the API. It will also allow for an API first approach to the API.

  • HOW: This was just the first one that came up when I googled it: https://django-rest-swagger.readthedocs.io/en/latest/. But there's a bunch of packages that might help with this.

  • WHAT: This is an example, see: https://petstore.swagger.io/.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions