Make your APIs Discoverable with APIs.json
The article discusses the importance of discoverability for APIs and introduces APIs.json as a solution. APIs.json is a specification that aims to solve API discoverability, created by Kin "API Evangelist" Lane and Steven Willmott. It contains two simple concepts: a "Well Known" URL of /apis.json or /apis.yaml, and a specific JSON/YAML data format for that URL. The APIs.json file helps software find your APIs and learn about them by providing metadata about the collection of APIs and an array of APIs with their respective details. Bump.sh automatically creates an /apis.json for anyone using Documentation Hubs, which can be used to submit APIs to API marketplaces like APIs.io. Other potential uses for APIs.json include quality assurance on developer portals and monitoring by advertising health endpoints of APIs.
Company
Bump
Date published
June 3, 2024
Author(s)
Phil Sturgeon
Word count
1422
Language
English
Hacker News points
None found.