Skip to content

[DOCUMENTATION] Setup OpenAPI Documentation #33

@ZombiMigz

Description

@ZombiMigz

User Story

As a developer, I want automatically generated documentation for REST endpoints so I can easily understand what each endpoint does.

Technical Tasks

  • Follow this tutorial
  • You don't need to follow it word for word
  • Make sure you can explain the process of adding endpoints to the documentation, so we can get devs to do this in the future

Acceptance Criteria

  • an endpoint returns API docs as a readable page
  • another endpoint returns the OpenAPI/Swagger definition in JSON

Metadata

Metadata

Assignees

No one assigned

    Labels

    DifficultThis may include advanced topics, concepts or applicationsdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions