Enrich Swagger with XML Comments and Examples.
Description:
To improve our generated API documentation in Starlight, we need to enrich the swagger.json output from the .NET backend.
- Enable XML documentation generation in
Cinema.Api.csproj.
- Add XML comments (
/// <summary>) to all Controllers and Endpoints.
- Add
<example> tags or [DefaultValue] attributes to DTOs (e.g., CreateOrderCommand, LoginUserCommand) to provide realistic payload examples.
- Once deployed, the Starlight docs will automatically reflect these examples.
Enrich Swagger with XML Comments and Examples.
Description:
To improve our generated API documentation in Starlight, we need to enrich the
swagger.jsonoutput from the .NET backend.Cinema.Api.csproj./// <summary>) to all Controllers and Endpoints.<example>tags or[DefaultValue]attributes to DTOs (e.g.,CreateOrderCommand,LoginUserCommand) to provide realistic payload examples.