Whether you’re a startup developing your first API or an established player in the API economy, the truth is becoming steadily more apparent; providing quality API documentation is vital to the success of an API initiative. API documentation is an important part of the product offering, delivering affordances to the developer community to help them understand exactly what an API offers and how to use it. Read more
Posts Tagged: documentation
Few things are as important to an industry as common understanding and definitions. Without knowing exactly what industry-specific terms mean, and how they apply to given situations, little discourse API development can take place. It seems strange, then, that there are still so many terms in the API space that are misunderstood or misused. Read more
APIs are necessarily a communal endeavor — the community fostered between the users, the providers, and those who depend on the API for the functions of their own services drives the development environment of the API space.
Accordingly, developer outreach is absolutely essential for cultivating an API’s network of users and agents. Read more
Understanding the difference between an API (Application Programming Interface) and an SDK (Software Development Kit), and knowing when to provide each, is incredibly important for fostering a developer ecosystem. In the modern development landscape, these two tools and the synchronicity between them are the driving force behind web communication and the implementation of third-party APIs. 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