Expanding the Definition of Our API Contracts

https://apievangelist.com/2024/07/06/expanding-the-definition-of-our-api-contracts/

"As a potential consumer of an API, is it enough that I the API producer only publish an OpenAPI and share that with you? No, of course not" -- #KinLane

#api360 #apiCatalog #apisJSON

Expanding the Definition of Our API Contracts

In recent years we’ve begun collectively using the phrase “API contract” to often describe the OpenAPI or AsyncAPI for our APIs. While I have been complicit in the adoption of this phrase, and support its usage anytime I can, I also feel that it also reflects much of what is deficient with the API Economy. I agree that an OpenAPI represents a contract between producer and consumer, but I am painfully aware of how this represents just the technical side of this contract, and much of the business side of things is taken for granted or not addressed at all.

API Evangelist

Using APIs.json to Create a Catalog of APIs

https://apichangelog.substack.com/p/using-apisjson-to-create-a-catalog

"One of the greatest things about building technology publicly is how anyone can follow what you're doing. That's exactly what's been happening with the APIs.json specification and the api-catalog IETF draft. Are these two projects overlapping? Or, can they complement each other?" -- #BRUNO_PEDRO

#api360 #apiCatalog #APIsJSON

Using APIs.json to Create a Catalog of APIs

What is missing for APIs.json to take off as the standard for publishing API catalogs?

The API Changelog

Moving API Docs From Human-Readable to Machine-Readable https://buff.ly/3TPK2KV

"I have more faith that we will get humans to adopt or at least auto-generate OpenAPI and APIs.json than I believe we’ll develop AI to unwind this mess." -- #KinLane

#api360 #apiDocs #apisJSON

Moving API Docs From Human-Readable to Machine-Readable

One of the super powers of APIs.json is the ability to evolve the human-readable aspects of API operations into machine-readable ones–as this is how we are going to scale to deliver the API economy all of us API believers envision in our minds eye. I saw what Swagger (now OpenAPI) had done for API documentation back in 2013, and I wanted this for the other essential building blocks of our API operations. A decade later I am still translating our getting started, plans, SDKs, road map, change log, and support into machine-readable artifacts as part of our API Commons work, but I am still working to translate documentation into machine-readable artifacts as well.

API Evangelist