We walkthrough using APIcurio, an API design editor supporting OpenAPI Spec.Having a thoroughly documented, machine-readable API is considered top of the line development. However, creating a consistent format for the API and documentation is challenging with no outside guidance or structure. Read more
Posts Tagged: metadata
A Software Developer Kit, or SDK is perhaps one of the most important things a web API can have. SDKs are a helpful system of libraries and frameworks to support the API, often including documentation and other guidelines.
What can’t be argued are their significance to developers. Read more
“Build it and they will come” is certainly not the case in the API world. Even if you have a functionally brilliant service, without the right positioning your conversion rates could still be very low. Assuming you’ve made your developer program visible to the public, how should you then promote your API? Read more
The most common API definition languages we spot in the wild are Swagger / OpenAPI Spec, RAML and API Blueprint. All three let you define your endpoints, your resources, your query or path parameters, your headers, status codes, security schemes, and more. Read more
This is the third article on a series that aims to put the focus of Web APIs back on the Web, on its underlying architecture and on what it means to build evolvable APIs for it. In this first we introduced the architecture of the Web along with its first pillar — Identification. Read more