How To (And How Not To) Design REST APIs
tl;dr: "In my career, I have consumed hundreds of REST APIs and produced dozens. Since I often see the same mistakes repeated in API design, I thought it might be nice to write down a set of best practices. And poke fun at a couple widely-used APIs. Much of this may be "duh", but there might be a few rules you haven't considered yet."
featured in #462
How We Improved Our Serverless API 300x
tl;dr: ePilot's team improved their serverless API response time by 300x using AWS DynamoDB. They initially faced issues due to a simplistic table design without understanding search patterns and a 10x increase in record data. By redesigning the table and storing more data, they optimized queries, making them 10-20 times faster. The experience emphasized the importance of understanding search patterns and proper design in DynamoDB.
featured in #438
Common Design Patterns At Stripe
tl;dr: “You might disagree with how the Stripe API is designed, and the design you end up with is likely going to be different than what we use. That’s just fine, since different companies have different use cases. Instead I present here some design patterns that I believe are generic enough to be useful for just about anyone in the API design process.”
featured in #431
HasuraCon 2023 is June 20-22 - Virtual and Free
tl;dr: HasuraCon is bringing together experts to explore the latest trends, insights, and innovations in the world of GraphQL, data architecture, and app development in this free, online 3-day event. Data APIs are reshaping the world of data delivery, helping enterprises do more by serving data where and when it’s needed in a fast, secure, flexible way. Hasura and its customers are at the forefront, driving this shift. Costco, Verizon, Atlassian, General Mills, and over 40 Fortune 100 companies use Hasura.
featured in #422
Boost Your Team's Productivity With Postman Workspaces
tl;dr: API collaboration is essential for driving development efforts forward. Postman Workspaces help teams streamline the process, ensuring APIs are consistently available, highly performant, and meet consumer needs. Discover how to collaborate effectively at every stage of the API lifecycle in an API-first world.
featured in #413
Benefits Of API Collaboration In An API-First World
tl;dr: Collaboration is the key to successful API development. Whether it's working with internal teams or external partners, effective collaboration can help teams work faster, smarter, and with fewer errors. In this article, we explore the best practices for API collaboration and offer tips for working more effectively across the entire API lifecycle.
featured in #412
Meaningful Collaboration Across The API Lifecycle
tl;dr: Collaboration is at the heart of successful software development, but working together on APIs brings challenges. In this article, Kin Lane, Chief Evangelist at Postman dives into the critical components of meaningful API collaboration across the API lifecycle and provides insights and strategies for success.
featured in #411
When To Use gRPC vs GraphQL
tl;dr: "I’ve read a lot of comparisons of these two protocols and wanted to write one that is comprehensive and impartial... I was inspired by the release of connect-web (a TypeScript gRPC client that can be used in the browser) and a popular HN post entitled GraphQL kinda sucks." Loren writes a thorough comparison.
featured in #375
Structured Error Messages For HTTP APIs
tl;dr: Nicolas identifies 2 problems: (1) HTTP status codes were specified for human-to-machine interactions via browsers, not for machine-to-machine interactions via APIs. Hence, selecting a status code that maps one-to-one to the use case is rarely straightforward. (2) The error payload's structure is unimportant if a single organization manages the client and the API provider. However, the issue occurs when a team decides to use a third-party API.
featured in #364
OpenAPI Tutorial: How to Automatically Generate Tests for OpenAPI Generator SDKs
tl;dr: OpenAPI is an industry-standard definition language for building patterned, uniform APIs. This OpenAPI Tutorial includes code samples, templates, and testing strategies for generating SDK code for APIs you're building.
featured in #349