Qodex.ai

API Design Guide

Number of APIs: 11

API Design is the first and the most important part of an API's Lifecycle. A well-designed API is easy, and intuitive to use.

For someone who is just starting their journey in API design, this API Design Guide collection will work as a reference to help them design simple, consistent and easy-to-use REST APIs.

  1. Resource Names - Fetch a particular cat GET {{url}}/cats/:id

  2. Searching - Search cats with name GET {{url}}/cats?q={{query}}

  3. HTTP methods - Add new cat POST {{url}}/cats

  4. Resource Names - Fetch all cats GET {{url}}/cats

  5. HTTP methods - Delete cat details DELETE {{url}}/cats/:id

  6. HTTP methods - Update cat details PUT {{url}}/cats/:id

  7. Paginatation - Fetch cats GET {{url}}/cats?offset=1&limit=10

  8. Filtering - Filter cats by breed GET {{url}}/cats?breed={{breedName}}

  9. Sorting - Fetch cats, sorted by name (descending) GET {{url}}/cats?sort=-name

  10. Versioning - Fetch all cats (v2) GET {{url}}/v2/cats