An API or application programmable interface is a software contract that defines the expectations and interactions of a piece of code exposed to external users. This includes the parameters, response, errors, and API name.

We discuss how to design an API and what it takes to make the design scalable, extensible, and easy to use. HTTP APIs are widely used in software systems. HTTP is a stateless protocol and systems often provide APIs that use it.

00:00 Who needs to see this?
00:13 What is an API?
01:41 Best practices
02:22 Naming APIs
02:43 Defining parameters
03:29 Defining response objects
05:02 Defining errors
06:22 HTTP endpoints
07:47 GET vs. POST
09:10 Side effects
12:09 Pagination
13:51 Data consistency
15:11 Thanks!

Recommended system design video course:
https://interviewready.io

In addition to video lectures, this course includes architecture diagrams, capacity planning, API contracts, and evaluation tests. It is a complete package.

References:
https://medium.com/airbnb-engineering/building-services-at-airbnb-part-1-c4c1d8fa811b
https://swagger.io/docs/specification/about/
Designing data-intensive applications – https://amzn.to/2yQIrxH
System Design Playlist: https://www.youtube.com/playlist?listPLMCXHnjXnTnvo6alSjVkgxV-VH6EPyvoX

You can follow me on:
Facebook: https://facebook.com/gkcs0/
Quora: https://www.quora.com/profile/Gaurav-Sen-6
LinkedIn: https://www.linkedin.com/in/gaurav-sen-56b6a941/

Please take the opportunity to connect and share this video with your friends and family if you find it useful.