August 28th, 2019 ×

How to Build an API


In this episode, Scott and Wes talk about creating APIs — what's happening behind the scenes and why it's important.

Sanity - Sponsor

Sanity.io is a real-time headless CMS with a fully customizable Content Studio built in React. Get a Sanity powered site up and running in minutes at sanity.io/create. Get an awesome supercharged free developer plan on sanity.io/syntax.

Sentry - Sponsor

If you want to know what's happening with your errors, track them with Sentry. Sentry is open-source error tracking that helps developers monitor and fix crashes in real time. Cut your time on error resolution from five hours to five minutes. It works with any language and integrates with dozens of other services. Syntax listeners can get two months for free by visiting Sentry and using the coupon code "tastytreat".

Show Notes

2:15 - How do you build an API from scratch?

3:54 - Choose an API type

8:15 - Setup some sort of server that will accept requests and send responses

11:11 - Document the endpoints

  • What is the end point
  • What parameters are required
    • Filters
    • Sorting
  • Headers required
  • What you get back when you hit this endpoint
  • Any request limits
  • Examples in common languages
    • JS
    • PHP
    • Ruby

21:20 - Naming

  • Make it obvious

27:39 - Securing

32:42 - Protecting

36:00 - Write resolvers

  • Modify data if needed
  • Send back the data requested
  • Send back the correct HTTP code
  • Log what happened

37:56 - Tools


Shameless Plugs

Tweet us your tasty treats!


Play / pause the audio
Minimize / expand the player
Mute / unmute the audio
Seek backward 30 seconds
Seek forward 30 seconds
Increase playback rate
Decrease playback rate
Show / hide this window