API Product Requirements Document

J

Jordan Reyes

@jordan-reyes

·

Create comprehensive API product requirements documents

45 copies0 forks
Share this prompt:
Write an API-focused PRD for {{api_feature}}.

Context:
- Target developers: {{developer_segment}}
- Integration use case: {{use_case}}
- Platform constraints: {{constraints}}

API PRD Structure:

1. OVERVIEW
- API purpose and value proposition
- Target developer persona
- Key use cases enabled

2. FUNCTIONAL REQUIREMENTS
- Endpoints required
- Request/response schemas
- Authentication method
- Rate limiting approach

3. NON-FUNCTIONAL REQUIREMENTS
- Latency targets (p50, p95, p99)
- Availability target
- Throughput requirements
- Data retention

4. DEVELOPER EXPERIENCE
- Documentation requirements
- SDK/library needs
- Sandbox/testing environment
- Error handling patterns

5. VERSIONING & DEPRECATION
- Versioning strategy
- Breaking change policy
- Deprecation timeline
- Migration support

6. SECURITY REQUIREMENTS
- Authentication options
- Authorization model
- Data privacy considerations
- Compliance requirements

7. SUCCESS METRICS
- Adoption metrics
- Quality metrics (error rates, latency)
- Developer satisfaction measures

Details

Category

Productivity

Use Cases

Specify API productsDocument API requirementsGuide API development

Works Best With

gpt-4claude-3
Created Updated Shared

Related Prompts

Create your own prompt vault and start sharing