From affolternet-web-api
Configure Swagger/OpenAPI documentation for affolterNET.Web.Api. Use when setting up API documentation, customizing Swagger UI, or configuring OpenAPI metadata.
How this skill is triggered — by the user, by Claude, or both
Slash command
/affolternet-web-api:swaggerThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Configure Swagger/OpenAPI documentation for your API.
Configure Swagger/OpenAPI documentation for your API.
For complete reference, see Library Guide.
{
"affolterNET": {
"Web": {
"Swagger": {
"Enabled": true,
"Title": "My API",
"Version": "v1",
"Description": "API documentation for My Application"
}
}
}
}
| Property | Type | Default | Description |
|---|---|---|---|
Enabled | bool | true (dev) | Enable Swagger UI and endpoint |
Title | string | "API" | API title in Swagger UI |
Version | string | "v1" | API version |
Description | string | null | API description |
RoutePrefix | string | "swagger" | URL prefix for Swagger UI |
{
"affolterNET": {
"Web": {
"Swagger": {
"Enabled": true
}
}
}
}
In production, set Enabled to false or remove the configuration.
{
"affolterNET": {
"Web": {
"Swagger": {
"Enabled": true,
"RoutePrefix": "api-docs"
}
}
}
}
Access at: https://your-api.com/api-docs
When authentication is enabled, Swagger UI will include the authorization header configuration for testing authenticated endpoints.
Use XML comments for API documentation:
/// <summary>
/// Gets all users
/// </summary>
/// <returns>List of users</returns>
/// <response code="200">Returns the list of users</response>
/// <response code="401">Unauthorized</response>
[HttpGet]
[ProducesResponseType(typeof(List<User>), 200)]
[ProducesResponseType(401)]
public IActionResult GetUsers() { ... }
Enable XML documentation in your .csproj:
<PropertyGroup>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>
Enabled is true in configurationRoutePrefix matches your expected URLnpx claudepluginhub affolternet/affolternet.web --plugin affolternet-web-apiGenerates and customizes OpenAPI 3.1 documentation for .NET 10 apps using built-in transformers and TypedResults. Use for API docs, security schemes, and client generation.
Generating OpenAPI docs. MS.AspNetCore.OpenApi (.NET 9+), Swashbuckle migration, NSwag.
Generates or reviews OpenAPI/Swagger documentation for Spring Boot REST APIs by adding @Operation, @Schema, @ApiResponse annotations and configuring Swagger UI.