Skip to content
  • Home
  • About
  • No Access
  • Privacy Policy
Bits of .NET
Bits of .NET
  • Asp.Net Core
  • C#
  • SQL
  • JavaScript
  • CSS
  • About
  • ErcanOPAK.com
  • No Access
  • Privacy Policy

Bits of .NET

Daily micro-tips for C#, SQL, performance, and scalable backend engineering.

  • Asp.Net Core
  • C#
  • SQL
  • JavaScript
  • CSS
  • About
  • ErcanOPAK.com
  • No Access
  • Privacy Policy
AI

AI Prompt: Generate Production-Ready API Documentation from Code Comments

- 01.02.26 | 01.02.26 - ErcanOPAK

Turn scattered code comments into beautiful, structured API docs in seconds with this prompt template.

The Prompt Template:

You are a technical documentation expert. Analyze the following code and generate comprehensive API documentation.

**Input Code:**
[PASTE YOUR CODE HERE]

**Output Requirements:**
1. Extract all public methods/endpoints
2. For each endpoint, document:
   - HTTP method and route
   - Purpose (one sentence)
   - Request parameters (name, type, required/optional, description)
   - Request body schema (if applicable)
   - Response format (success and error cases)
   - Example request with curl
   - Example response JSON
3. Group endpoints by resource/controller
4. Use OpenAPI 3.0 format
5. Include authentication requirements

**Format:** Output as markdown with code blocks for examples.

Real Example – C# Controller:

// Paste this code into the prompt:
[ApiController]
[Route("api/[controller]")]
public class UsersController : ControllerBase
{
    // GET api/users/{id}
    [HttpGet("{id}")]
    public async Task<ActionResult> GetUser(int id)
    {
        var user = await _db.Users.FindAsync(id);
        if (user == null) return NotFound();
        return user;
    }
    
    // POST api/users
    [HttpPost]
    public async Task<ActionResult> CreateUser(CreateUserDto dto)
    {
        var user = new User { Name = dto.Name, Email = dto.Email };
        _db.Users.Add(user);
        await _db.SaveChangesAsync();
        return CreatedAtAction(nameof(GetUser), new { id = user.Id }, user);
    }
}

AI Output You’ll Get:

## Users API

### Get User by ID
**Endpoint:** `GET /api/users/{id}`

Retrieves a single user by their unique identifier.

**Parameters:**
- `id` (integer, required): User's unique ID

**Success Response (200):**
```json
{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com"
}
```

**Error Response (404):**
```json
{
  "error": "User not found"
}
```

**Example Request:**
```bash
curl -X GET https://api.example.com/api/users/123 \
  -H "Authorization: Bearer YOUR_TOKEN"
```

Advanced Version – Generate Postman Collection:

After generating the markdown docs above, create a Postman Collection JSON with:
- All endpoints pre-configured
- Example requests with sample data
- Environment variables for base URL and auth tokens
- Tests for status code validation

Output the collection as importable JSON.

Why This Saves Hours:
Manual API documentation typically takes 15-30 minutes per endpoint. For a 20-endpoint API, that’s 5-10 hours. This prompt does it in 2 minutes. You just review and refine.

Bonus – Keep Docs in Sync:
Add this as a git pre-commit hook to auto-update docs when code changes. Use the AI API programmatically to regenerate docs on every commit to main.

Related posts:

The AI Prompt That Turns a Pile of Warranty Receipts Into a Reminder List Before Coverage Quietly Ex...

The AI Prompt That Turns a Pile of Warranty Receipts Into a Reminder List Before Coverage Quietly Ex...

AI Prompt: Refactor Legacy Code to Modern Standards

AI Prompt: Refactor Legacy Code to Modern Standards

The AI Prompt That Finds Every CSS Class Defined in Your Stylesheet but Never Used in Your HTML

The AI Prompt That Finds Every CSS Class Defined in Your Stylesheet but Never Used in Your HTML

Views: 20

Post navigation

Reduce Docker Image Sizes by 10x with Multi-Stage Builds
AI Prompt: Debug Production Errors by Analyzing Stack Traces and Logs

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

November 2026
M T W T F S S
 1
2345678
9101112131415
16171819202122
23242526272829
30  
« Oct    

Most Viewed Posts

  • How to make theater mode the default for Youtube (1,068)
  • Get the User Name and Domain Name from an Email Address in SQL (990)
  • How to add default value for Entity Framework migrations for DateTime and Bool (986)
  • Get the First and Last Word from a String or Sentence in SQL (865)
  • How to select distinct rows in a datatable in C# (859)
  • How to enable, disable and check if Service Broker is enabled on a database in SQL Server (661)
  • Add Constraint to SQL Table to ensure email contains @ (619)
  • Average of all values in a column that are not zero in SQL (577)
  • How to use Map Mode for Vertical Scroll Mode in Visual Studio (553)
  • Find numbers with more than two decimal places in SQL (481)

Recent Posts

  • Network Speed Monitor Windows Application v2.5.1
  • Ağ Hızı İzleyici Windows Uygulaması v2.5.1
  • How to make theater mode the default for Youtube
  • The AI Prompt That Audits a Function for Thread-Safety Gaps
  • Ajax: Fix a Fetch Request Caching a Response Despite No-Store
  • WordPress: Fix a Navigation Block Losing Submenu Items After Sync
  • Visual Studio: Fix CodeLens Reference Counts Stuck at Stale Numbers
  • C#: Fix a UTF-8 String Literal Behaving Differently in a Switch
  • Photoshop: Fix a Liquify Mesh Snapping Back on a Smart Object
  • The AI Prompt That Turns a Crash Dump Into a Short Repro Script

Most Viewed Posts

  • How to make theater mode the default for Youtube (1,068)
  • Get the User Name and Domain Name from an Email Address in SQL (990)
  • How to add default value for Entity Framework migrations for DateTime and Bool (986)
  • Get the First and Last Word from a String or Sentence in SQL (865)
  • How to select distinct rows in a datatable in C# (859)

Recent Posts

  • Network Speed Monitor Windows Application v2.5.1
  • Ağ Hızı İzleyici Windows Uygulaması v2.5.1
  • How to make theater mode the default for Youtube
  • The AI Prompt That Audits a Function for Thread-Safety Gaps
  • Ajax: Fix a Fetch Request Caching a Response Despite No-Store

Social

  • ErcanOPAK.com
  • GoodReads
  • LetterBoxD
  • Linkedin
  • The Blog
  • Twitter
© 2026 Bits of .NET | Built with Xblog Plus free WordPress theme by wpthemespace.com