Skip to content

Auto-generate Swagger/OpenAPI docs #72

Description

@Serbel97

Is your feature request related to a problem? Please describe.
Right now, it looks like there’s no built-in way to auto-generate Swagger/OpenAPI docs for APIs created with django_api_forms. That makes it harder to understand available endpoints, request fields, and expected responses without digging into the code.

Describe the solution you'd like
It would be great if django_api_forms could support automatic Swagger/OpenAPI schema generation.

Ideally this could include:

  • generating schema from form definitions
  • Swagger UI and/or ReDoc support
  • documenting request fields, types, required fields, and maybe validation rules

Describe alternatives you've considered
Manual documentation is possible, but it can get outdated pretty quickly. Another option is custom integration with tools like drf-spectacular or drf-yasg, but built-in support (or official integration) would be much easier.

Additional context
Since the project already uses Django forms to define API input, it seems like a natural fit for auto-generating API docs from that.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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