Phil Sturgeon

openapi

Turn HTTP Traffic into OpenAPI with Optic

Capture real HTTP traffic from production or anywhere else, and create OpenAPI from it, for documentation, mocks, SDKs, or contract testing.

Securing APIs with the Spectral OWASP Ruleset

Recently I've been on a run of making new all powerful Spectral rulesets, but so far it's been focused on the concept of automating style guides, with the concrete example of the APIs You Won't Hate: API Style Guide showing how it can be

🎙️ APIs You Won't Hate (The Podcast)

Don't roll your own API Management tools, with Josh Twist from Zuplo

Our guest this episode is Josh Twist, CEO and Co-founder of Zuplo. We chat about Zuplo's history, their developer products and audience, and the complexities of maintaining APIs in small and large companies.

Testing Spectral Style Guides with Jest

Readers of this blog will be familiar with the concept of Automating API style guides implemented with programable API linters like Spectral. When combined with the power of API Design-First, these API style guides can power the core of your API design reviews, improving consistency and reducing the frequency of

Distribute Spectral Style Guides with NPM

At some point in the growth of an organization there will come a time where you've got too many different APIs with random different data formats, naming conventions, security schemes, and generally it feels bizarre and frustrating trying to call any API because you cannot share any code

Contract Testing a Laravel API with OpenAPI

Your API does a bunch of great stuff, and your OpenAPI document tells everyone about all the great stuff that your API can do, but making sure those two sources of truth agree can be a bit of a struggle at first. Whether you followed the API design-first workflow and

Creating OpenAPI from HTTP Traffic

Around this time of year we're thinking about things we're going to do differently, new practices we've been putting off for too long, and mistakes we want to avoid continuing into another year. For many of us in the API world, that is going

Why Show Users Garbage API Errors?

A million things can go wrong when an API client talks to an API, from the expected to the unexpected, from business logic and validation failures, to dropped connections and race conditions. The server could run out of RAM, the request could time out, an automatic retry might trigger a

There's No Reason to Write OpenAPI By Hand

Some API developers use API descriptions to plan the interface of an API before building it, which is known as the "API design first" workflow. Others build the API then generate (or manually produce) API descriptions later, which is the "code-first" workflow. We wrote API Design-first

OpenAPI v3.1 and JSON Schema

Updated 2019-05-29: OpenAPI v3.1 has dropped SemVer, so a few things that were going to be deprecated are now just straight up removed. This post has been updated to reflect that. Updated 2021-01-10: JSON Schema released Draft 2020-12 which clarified a few edge cases, it's not a

Automated Style Guides for REST, GraphQL and gRPC

Ask 100 developers where a semicolon should go, and you'll either get 100 answers, or a all-on-all fist fight. To save this from happening at work, most folks implement a style guide, which beyond helping with consistent style to avoid new developers getting shouted at for "doing

API Design-First vs Code First

With API descriptions rising in popularity, the main question I hear folks asking about is "API Design-first" or "code-first". This is a bit of a misleading question because these are not two unique things, there are a few variants. Code-First, Write Docs "When We Have