OpenAPI Specification
- Tyler Seale
OAS documentation
What is OpenAPI Specification (OAS)
As described by spec.openapis.org:
The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.
How AdCellerant uses OAS
The AdCellerant API conforms to the latest 3.1.0 OAS. When we release a new version of our code, an OAS json file is auto generated for our APIs.
What can OAS do for you
Since OAS is a widely adopted spec, many tools are capable of taking a defined spec (like the json AdCellerant generates) and generating things such as human readable documentation or client libraries in various coding languages (typescript, java, python, etc.). There are lots of sources out there for generating a client library for whatever language you are writing in.
AdCellerant Published OAS
The spec that matches the AdCellerant API will be updated as new versions of the API are released. These OAS changes will be documented and can be found attached to this document: