0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs/reference/contrib/api/index.rst
2017-03-07 10:49:19 +00:00

30 lines
726 B
ReStructuredText

Wagtail API v1
==============
.. warning::
This documentation covers the deprecated version 1 of the API, which is provided for backwards compatibility only. For the current version, see :doc:`/advanced_topics/api/index`
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