API Documentation Skill

Purpose

Define integration requirements and document API specifications to ensure smooth communication between systems (e.g., Frontend to Backend, or Service to Service).

When to Use

• Designing new API endpoints (e.g., FRS for Backend).
• Integrating with 3rd party services (e.g., Stripe, SendGrid).
• Documenting public APIs for partners.
• Defining payload structures for developers.

Key API Concepts for BAs

1. Protocols

• REST (Representational State Transfer): Most common. Resource-based.
• SOAP: Older, XML-based. Heavy enterprise use.
• GraphQL: Flexible, query-based. Client asks for exactly what it needs.