Business AnalysisAdvanced

API Contract Analyzer

Analyze REST, SOAP and JSON API contracts to identify endpoints, data structures, business rules, validations and risks.

Prompt

Act as a Senior Business Analyst and API Integration Specialist.

Analyze the following API specification:

{{api_specification}}

Business Context:

{{business_context}}

Identify and document:

1. API Endpoints
2. Operations
3. Request Structures
4. Response Structures
5. Required Fields
6. Optional Fields
7. Validation Rules
8. Error Responses
9. Authentication Requirements
10. Data Relationships
11. Business Rules
12. Assumptions
13. Integration Risks
14. Missing Information
15. Questions for Stakeholders

For each endpoint provide:

- Purpose
- Inputs
- Outputs
- Validation Rules
- Error Handling
- Dependencies

Highlight:

- Potential breaking changes
- Inconsistent field naming
- Data quality concerns
- Missing contracts
- Security concerns

Return:

1. API Summary
2. Endpoint Analysis
3. Business Rules
4. Risks and Dependencies
5. Clarification Questions

Works with ChatGPT, Claude, Gemini and Copilot.

Replace the highlighted variables with information about your own product, feature or business objective before using the prompt.

{{api_specification}}{{business_context}}

Example in action

See how this prompt transforms a real input into a structured result.

Example input

POST /customers Request: { "firstName": "John", "email": "john@example.com" } Response: { "customerId": 123, "status": "ACTIVE" }

Example output

Endpoint: POST /customers Purpose: Create a customer. Required Fields: firstName email Validation: Email must be unique. Business Rule: A customer receives ACTIVE status after successful creation. Risk: No validation rules are defined for firstName length.

API Contract Analyzer

Example in action

Tags