REST API Design Document

Design a REST API with proper conventions

🧪 Tested by a human Advanced 👤 Developer 👤 Architect
Design a REST API for [PURPOSE]. Include: resource naming, endpoints with methods, request/response schemas, authentication, errors, pagination, rate limiting, versioning.

Works on

⭐ M365 Copilot (Best) 🟢 ChatGPT 🟠 Claude

Copy & Open in

🟢 ChatGPT 🟠 Claude

Prompt is copied to your clipboard when you click

Tips for Best Results

  • Try this prompt in M365 Copilot for best results with your work data
  • Customise the variables in square brackets with your specific details
  • Use the Prompt Polisher tool to refine and improve this prompt further

📎 More Prompts

API Documentation Generator

●●
Generate API documentation for [API NAME]. For each endpoint include: (1) HTTP method and path, (2) Description of what it does, (3) Request parameters with types and required/optional, (4) Request body schema with examples, (5) Response schema with examples, (6) Error codes and meanings, (7) Authentication requirements. Format as Markdown.
🟢 GPT ⭐ Claude

Code Review Assistant

●●
Review this code and provide feedback on: (1) Bugs or logic errors, (2) Security vulnerabilities, (3) Performance issues, (4) Readability and naming, (5) Missing error handling, (6) Test coverage gaps. For each issue: explain the problem, show the fix, and rate severity (critical, important, minor). [PASTE CODE]
🟢 GPT ⭐ Claude

Database Migration Script

●●●
Write a migration script for [CHANGE]. Include: up migration, down migration (rollback), data preservation, validation queries, estimated execution time. Include safety checks.
⭐ M365 🟢 GPT 🟠 Claude
💬