Skip to content

[Core] Create API Documentation Portal #3

@NeftaliYagua

Description

@NeftaliYagua

Description

Create an interactive API documentation portal using Swagger/OpenAPI for all Prodaric endpoints.

Acceptance Criteria

  • Swagger UI integrated and accessible at /api/docs
  • All endpoints documented with summaries and descriptions
  • Request/response schemas with examples
  • Authentication flows documented
  • Error responses documented
  • API versioning strategy documented
  • Rate limiting information included
  • Code samples in multiple languages (C#, JavaScript, Python, cURL)
  • Try-it-out functionality working
  • OpenAPI 3.0 specification exported

Subtasks

  • Install and configure Swashbuckle
  • Add XML documentation to all controllers
  • Configure Swagger generation options
  • Add authentication to Swagger UI
  • Create custom examples for complex types
  • Add operation tags and grouping
  • Configure response types and status codes
  • Add deprecation notices for old endpoints
  • Style Swagger UI with Prodaric branding
  • Export OpenAPI spec to /api/openapi.json

Technical Notes

  • Use Swashbuckle.AspNetCore for .NET 8
  • Enable XML documentation file generation
  • Use data annotations for validation documentation
  • Add custom operation filters for common patterns

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status

    Todo

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions