wagtail/docs/reference/contrib/api/index.rst

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
Added contrib.wagtailapi module. Closes #926 Imported from: https://github.com/torchbox/wagtailapi Thanks to @timheap for the review 2015-03-02 10:19:58 +00:00			`Wagtail API`
			`===========`

Started fixing spellings. Added wordlist 2015-04-17 22:05:08 +00:00			The ``wagtailapi`` module can be used to create a read-only, JSON-based API for public Wagtail content.
Added contrib.wagtailapi module. Closes #926 Imported from: https://github.com/torchbox/wagtailapi Thanks to @timheap for the review 2015-03-02 10:19:58 +00:00
			`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`