Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For further information on writing plugins, see: Writing plugins for Canopy.

...

Canopy API

TODO: swagger documentation has been created as a first cut, however, an improved swagger interface is required to help users.

Document processors

TBCThe Canopy API is implemented in a (mostly) RESTful manner. For general information on REST APIs, see: http://www.restapitutorial.com/.

Canopy's API is based on the django-rest-framework (DRF) solution. Further details about DRF can be found at: http://www.django-rest-framework.org/.

An overview of the main concepts in the Canopy API can be found here: Canopy API.

A sample demo API client is available here: Demo API Client.