Skip to main content

Open API description

OpenAPI is a standard specification for describing REST APIs. OpenAPI descriptions allow both humans and machines to discover the capabilities of an API without needing to first read documentation or understand the implementation. GitHub has made its REST API publicly available as an OpenAPI 3.0 compliant document.

Getting the CodeNOW OpenAPI description​

You can find the description on this endpoint:

https://api.cloud.codenow.com/swagger/vnd.codenow.v1+json.yml

Using the CodeNOW OpenAPI description​

There are many uses for an OpenAPI description. For example, you could:

  • Generate your own API client.
  • Validate and test a CodeNOW REST API integration.
  • Explore and interact with the CodeNOW REST API using third-party tools, such as Insomnia or Postman.

For example, CodeNOW uses the REST OpenAPI description to generate the CodeNOW's REST API reference documentation.