Skip to main content

4 posts tagged with "engineering"

View All Tags

Adding a links field to API responses

· 2 min read

We added a links field to our APIAPI A set of rules and protocols that allows different software applications to communicate with each other. APIs define the methods and data formats that applications can use to request and exchange information. response objects this week. Small change, and I'd put it off for a while because it felt like ceremony. It isn't.

Communicating state and events in API design

· 18 min read

A status field is a contract. It is also the place where most APIsAPI A set of rules and protocols that allows different software applications to communicate with each other. APIs define the methods and data formats that applications can use to request and exchange information. quietly leak ambiguity, a single word doing the work of three, consumed by people who weren't in the room when you named it. Get it right and an integrator can build correct handling from the payload alone. Get it wrong and they reverse-engineer your intentions from support tickets.

Stop abbreviating in your APIs

· One min read

A small plea: stop abbreviating field and method names in your APIsAPI A set of rules and protocols that allows different software applications to communicate with each other. APIs define the methods and data formats that applications can use to request and exchange information., SDKsSDK A collection of software development tools, libraries, documentation, code samples, and guides that help developers create applications for a specific platform or framework., and config.

Maybe I'll send an email once in a while

Monthly digest. No spam.