wagtail/docs/contrib/api/index.rst
Karl Hobley b86cb94bdf Added contrib.wagtailapi module. Closes #926
Imported from: https://github.com/torchbox/wagtailapi

Thanks to @timheap for the review
2015-03-31 09:24:20 +01:00

25 lines
519 B
ReStructuredText

Wagtail API
===========
The wagtailapi module can be used to create a read-only, JSON-based API for public Wagtail content.
There are three endpoints to the API:
* **Pages:** ``/api/v1/pages/``
* **Images:** ``/api/v1/images/``
* **Documents:** ``/api/v1/documents/``
See :doc:`installation` and :doc:`configuration` if you're looking to add this module to your Wagtail site.
See :doc:`usage` for documentation on the API.
Index
-----
.. toctree::
:maxdepth: 2
installation
configuration
usage