Add API Documentation Generator prompt

[Shreyanshsingh23]

Add API Documentation Generator Prompt

📋 Summary

This PR adds a new beginner prompt to the Goose Prompt Library: API Documentation Generator. This prompt helps engineering teams generate comprehensive API documentation from their code, filling a gap in the current prompt library.

🎯 Issue Reference

Closes #4995 - Beginner Prompt Submission #3

✨ What This Prompt Does

The API Documentation Generator prompt analyzes API code and generates comprehensive documentation including:

• API Overview - Base URL, authentication, versioning
• Endpoint Documentation - Detailed request/response schemas
• Interactive Examples - cURL, JavaScript, Python code samples
• Error Handling - Complete error codes and responses
• Testing Resources - Postman collections and SDK examples
• Rate Limiting - API limits and headers
• Changelog - Version history and updates

🔧 Technical Details

Requirements Met ✅

• Uses exactly 1 extension - Developer (built-in MCP server)
• Solves clear, straightforward task - Generate API documentation
• Includes all required fields - id, title, description, category, example_prompt, example_result
• JSON validates correctly - Structure tested and validated
• Unique filename - api-documentation-generator.json
• Title matches filename - "API Documentation Generator"

Extension Used

{
  "name": "Developer",
  "command": "developer",
  "is_builtin": true,
  "environmentVariables": []
}

📝 Example Usage

Input Prompt:

Analyze my Express.js API code and generate comprehensive documentation. I have a REST API with endpoints for user management, authentication, and data operations. Create interactive documentation with examples for each endpoint, including request/response schemas, error codes, and authentication requirements.

Output: Comprehensive API documentation with:

• Complete endpoint specifications
• Request/response examples in multiple formats
• Error handling documentation
• SDK examples for JavaScript, Python, and cURL
• Postman collection for testing
• Rate limiting and authentication details

🎯 Why This Prompt is Valuable

1. Fills a Gap - No existing prompts generate comprehensive API documentation
2. High Impact - Essential tool for engineering teams
3. Beginner-Friendly - Single extension, clear task, practical output
4. Comprehensive - Covers all aspects of API documentation
5. Real-World Ready - Provides actionable, production-ready documentation

🔍 Uniqueness Check

This prompt is unique in the library:

• api-endpoints-analysis.json - Analyzes routing configuration (different purpose)
• generate-toc.json - Generates markdown table of contents (different scope)
• No other comprehensive API documentation generation prompts exist

📊 Content Quality

• Example Prompt: 311 characters, clear and specific
• Example Result: 8,071 characters of detailed, realistic documentation
• Category: Technical (appropriate for engineering)
• Job: Engineering (matches target audience)

🧪 Testing

• ✅ JSON structure validated
• ✅ All required fields present
• ✅ Extension format correct
• ✅ No naming conflicts
• ✅ Comprehensive example content
• ✅ Follows beginner prompt guidelines

📁 Files Changed

• documentation/src/pages/prompt-library/data/prompts/api-documentation-generator.json (new file)

🚀 Ready for Review

This prompt is ready for immediate use and provides significant value to the Goose community. It addresses a real need in engineering workflows and follows all submission guidelines perfectly.

---

Prompt ID: api-documentation-generator
Category: Technical
Job: Engineering
Extension: Developer (built-in)
Status: Ready for merge ✅

[taniandjerry]

Thank you for your contribution, @Shreyanshsingh23 ! As we approach the weekend, wanted to let you know to expect review from the team come Monday, Eastern time. Appreciate your patience in that time!

[Shreyanshsingh23]

Thank you for your contribution, @Shreyanshsingh23 ! As we approach the weekend, wanted to let you know to expect review from the team come Monday, Eastern time. Appreciate your patience in that time!

Sadly but I will wait till the right time @taniandjerry :) Till then I will make sure to make any left changes so that my PR is ready to be merged.

[taniandjerry]

Thank you so much for sharing your contribution! The DCO check is failing, so this link will tell you how to fix it~

Then the team will finish review!

[iandouglas]

The prompt looks great and very thorough!

[Shreyanshsingh23]

The prompt looks great and very thorough!

Thanks @iandouglas and @taniandjerry for the support. I have made the DCO successful. I think we are ready to go.

[iandouglas]

running the final checks then we'll merge, thanks again!