/API

Everything You Need to Know About OpenAPI

tl;dr: API design is important, yet it is only useful if it's well-documented and consistently represented across every API surface area (docs, SDKs, etc.). OpenAPI gives you greater visibility into your API, enabling you to unify all aspects of errors, responses, and parameters, ensuring consistency. This open-source documentation project will help you understand the OpenAPI Specification.

featured in #556


The First Autogenerated SDK With gRPC And REST From Fern

tl;dr: This article explores how Pinecone used Fern's SDK generator to create its C# SDK with both gRPC and REST support - the first of its kind! Learn more about the benefits of using Fern to automate SDK creation and maintenance across multiple API languages.

featured in #556


Everything You Need to Know About OpenAPI

tl;dr: API design is important, yet it is only useful if it's well-documented and consistently represented across every API surface area (docs, SDKs, etc.). OpenAPI gives you greater visibility into your API, enabling you to unify all aspects of errors, responses, and parameters, ensuring consistency. This open-source documentation project will help you understand the OpenAPI Specification.

featured in #554


Everything You Need to Know About OpenAPI

tl;dr: API design is important, yet it is only useful if it's well-documented and consistently represented across every API surface area (docs, SDKs, etc.). OpenAPI gives you greater visibility into your API, enabling you to unify all aspects of errors, responses, and parameters, ensuring consistency. This open-source documentation project will help you understand the OpenAPI Specification.

featured in #550


Everything You Need to Know About OpenAPI

tl;dr: API design is important, yet it is only useful if it's well-documented and consistently represented across every API surface area (docs, SDKs, etc.). OpenAPI gives you greater visibility into your API, enabling you to unify all aspects of errors, responses, and parameters, ensuring consistency. This open-source documentation project will help you understand the OpenAPI Specification.

featured in #541


Everything You Need to Know About OpenAPI

tl;dr: API design is important, yet it is only useful if it's well-documented and consistently represented across every API surface area (docs, SDKs, etc.). OpenAPI gives you greater visibility into your API, enabling you to unify all aspects of errors, responses, and parameters, ensuring consistency. This open-source documentation project will help you understand the OpenAPI Specification.

featured in #537


How To (And How Not To) Design REST APIs

- Jeff Schnitzer 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 #537


How To (And How Not To) Design REST APIs

- Jeff Schnitzer 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 #536


Common Design Patterns At Stripe

- Paul Asjes 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 #526


Common Design Patterns At Stripe

- Paul Asjes 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 #525