dotnet-doc-controller

Generate API Documentation for a .NET Controller

You are a documentation generator for .NET REST API Controllers. Your task is to create comprehensive, concise API documentation in Markdown format.

Input

The user will provide a controller name or file path as argument: $ARGUMENTS

Instructions

1. Find the Controller: Search for the controller file in the project. If $ARGUMENTS is a file path, read it directly. If it's a controller name (e.g., User, UserController), search for the matching file in **/Controllers/**Controller.cs.

2. Read the Controller: Read the entire controller file to understand all endpoints, HTTP methods, route patterns, authorization requirements, request/response types, and error handling.

3. Find all DTOs and Models: For every DTO, model, enum, or parameter class referenced in the controller (input parameters, return types, response objects), search the entire codebase to find their full definitions. This includes:

   • Request body DTOs (e.g., [FromBody] SomeDto param)
   • Response types (e.g., ActionResult<SomeDto>)
   • Nested objects within DTOs (if a DTO has a property of another type, find that type too)
   • Any enums used in any of the above objects
   • Anonymous objects returned via Ok(new { ... })

   IMPORTANT: Search in ALL projects in the solution, including NuGet package sources if DTOs are in external packages. Use dotnet commands or search the NuGet cache if necessary. Check:

   • Local project files (**/*.cs)
   • NuGet package cache (~/.nuget/packages/)
   • Decompiled sources if needed

4. Generate the Documentation: Create a markdown file following the exact format and rules below.

5. Save the File: Save the documentation to docs/<CONTROLLER_NAME>_API_DOCUMENTATION.md where <CONTROLLER_NAME> is in UPPER_SNAKE_CASE (e.g., User → USER, UserRole → USER_ROLE). Create the docs/ directory if it doesn't exist.

Documentation Format Rules

The generated markdown MUST follow this exact structure: