OpenAPI description

The Weavy REST API is described in an OpenAPI 3.0 compliant document. OpenAPI is a standard specification for describing REST APIs which enable both humans and machines to easily discover the capabilities of an API.

Getting the OpenAPI description

The latest version of the description is always available here, but you can also navigate to /api/openapi.json on your Weavy backend server for a version that matches your deployment.

Using the OpenAPI description

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

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