AiPromptss
Back to browse

Key Information to Gather

I need to document a [REST/GraphQL/gRPC] API with the following details: - Base URL: [your base URL] - Authentication: [Bearer tokens/API keys/OAuth 2.0] - Mai…

Added May 19, 20260 views0 copies
Prompt
I need to document a [REST/GraphQL/gRPC] API with the following details:
- Base URL: [your base URL]
- Authentication: [Bearer tokens/API keys/OAuth 2.0]
- Main resources: [List 3-5 primary endpoints]
- Response format: JSON

Create a documentation outline that covers:
1.
Authentication setup
2.
[Resource 1] endpoints
3.
[Resource 2] endpoints
4.
Error handling
5.
Rate limits

Replace text in [BRACKETS] with your own values before pasting.