Every API Should Begin With a Github Repository
The API evangelist recommends a GitHub repository for every API to enable sharing of API definitions, schema, and documentation.
Join the DZone community and get the full member experience.Join For Free
I’m working on my API definition and design strategy for my human services API work, and as I was doing this, Box went all in on Opening, adding to the number of API providers I track on who not just have an OpenAPI, but also use Github as the core management for their API definition.
Part of my API definition and design advice for human service API providers, and the vendors who sell software to them, is that they have an OpenAPI and JSON schema defined for their API, and share this either publicly or privately using a Github repository. When I evaluate a new vendor or service provider as part of the Human Services Data API (HSDA) specification I’m beginning to require that they share their API definition and schema using Github. Having a machine-readable definition of the surface area of an API, and the underlying schema in a Github repo I can checkout, commit to, and access via an API is essential.
Every API should begin with a Github repository in my opinion, where you can share the API definition, documentation, schema, and have a conversation around these machine readable docs using Github issues. Approaching your API in this way doesn’t just make it easier to find when it comes to API discovery, but it also makes your API contract available at all steps of the API design lifecycle, from design to deprecation.
Published at DZone with permission of Kin Lane, DZone MVB. See the original article here.
Opinions expressed by DZone contributors are their own.