2
0

index.rst 867 B

1234567891011121314151617181920212223242526272829
  1. ===========
  2. Wagtail API
  3. ===========
  4. The API module provides a public-facing, JSON-formatted API to allow retrieving
  5. content as raw field data. This is useful for cases like serving content to
  6. non-web clients (such as a mobile phone app) or pulling content out of Wagtail
  7. for use in another site.
  8. There are currently two versions of the API available: v1 and v2. Both versions
  9. are "stable" so it is recommended to use v2. V1 is only provided for backwards
  10. compatibility and will be removed from Wagtail soon.
  11. See `RFC 8: Wagtail API <https://github.com/wagtail/rfcs/blob/master/accepted/008-wagtail-api.md#12---stable-and-unstable-versions>`_
  12. for full details on our stabilisation policy.
  13. Version 2 (recommended)
  14. =======================
  15. .. toctree::
  16. :maxdepth: 2
  17. v2/configuration
  18. v2/usage
  19. Version 1
  20. =========
  21. See :doc:`/reference/contrib/api/index`