A Proposal for APIs.json Version 0.17

24 Feb 2024

We have posted a draft proposal for APIs.json 0.17 based upon the work we've been doing with APIs.io over the last couple of months. The project has been dormant for a while, but with renewed investment in APIs.io, we are finding a need for new properties of the API discovery format.

This release is primarily about adding two new properties that play a role in APIs.json, APIs.io, and API Evangelist all working together to map the API landscape.

  • aid - A unique identifier at the collection and api levels.
  • overlays - References to collection and api level overlays.

After that we are adding a handful of property types that API producers can use to index their API operations:

  • GettingStarted
  • DeprecationPolicy
  • GraphQLSchema
  • Integrations
  • OpenAIPluginManifest
  • PostmanWorkspace
  • ServiceLevelAgreement
  • Versioning
  • Webhooks

These property types were identified profiling 75 APIs published to APIs.io, distilling what API producers are doing to manage their operations into properties that any API producer can use to index their operations..

You can see the latest version in use in the APIs.json Artisanal project, for two of the top API producers out there:

We'd love to hear any feedback on the spec, as well as the properties we are adding to the specification this round. We are learning a lot about what is needed from building APis.io, but would love to learn from other applications beyond just search.

The APIs.json specification is managed by Steve Willmott and Kin Lane, and we welcome contributes and feedback from the community.