Skip to content

ALLABOUTEM/API_design_cheat_sheet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 

Repository files navigation

API Gateway /Application layer

  • What is an API gateway?
  • Why use API gateway?
  • Core functionalities ?
  • While designing APIS
    • Naming
    • URI definition
    • Single responsibility principle
    • number of params
    • Type of request GET/POST/PUT/PATCH/DELETE
    • Authentication
    • Return status - 200, 201, 400,401, 403,404, 429, 500, 503
  • Additional items to discuss
    • Rate limiting
    • API versioning
    • Error handling
    • Caching
  • Listviews (special operations)
    • Pagination
    • Sorting
    • Searching
    • GET/POST
  • Alias
  • Documentation
  • Cheat sheet for each API
    • Objects
    • Each object - kind of CRUDL
    • URI
    • Request
      • Type
      • params
    • Response
      • Response code
      • Happy
      • Error

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published