Designing APIs

Workflows

• Resources: Identify resources and relationships
• Endpoints: Define URL structure and methods
• Request/Response: Define payloads and schemas
• Errors: Define error responses
• Document: Create OpenAPI spec

REST Principles

Resource Naming

• Use nouns, not verbs: /users not /getUsers
• Use plural: /users not /user
• Use kebab-case: /user-profiles not /userProfiles
• Nest for relationships: /users/{id}/orders