api-design

Resource naming : HTTP methods : Response codes : Example REST endpoint : Request example : Response example : Error response format : Query parameters : Response with pagination : Options : Example with JWT : URL versioning (recommended): Header versioning : Create OpenAPI 3.0 specification: Filtering : Sorting : Field selection : Batch operations : If REST doesn't fit, consider GraphQL: - Designing new REST APIs - Creating GraphQL schemas - Refactoring API endpoints - Documenting API specifications - API versioning strategies - Defining data models and relationships - Identify resources and entities - Define relationships between entities - Specify operations (CRUD, custom actions) - Plan authentication/authorization - Consider pagination, filtering, sorting - Use nouns, not verbs: /users not /getUsers - Use plural names: /users/{id} - Nest resources logically: /users/{id}/posts - Keep URLs short and intuitive - GET : Retrieve resources (idempotent) - POST : Create new resources - PUT : Replace entire resource - PATCH : Partial update - DELETE : Remove resources (idempotent) - 200 OK : Success with response body - 201 Created : Resource created successfully - 204 No Content : Success with no response body - 400 Bad Request : Invalid input - 401 Unauthorized : Authentication required - 403 Forbidden : No permission - 404 Not Found : Resource doesn't exist - 409 Conflict :...