BEdita
v3.7.0

REST API

  • Setup a frontend to consume API
  • Configuration
  • Response and Errors
  • Authentication
  • Pagination
  • Customize endpoints
  • Formatting BEdita objects
  • API reference
BEdita
  • Docs »
  • BEdita documentation
  • Edit on GitHub

BEdita documentation¶

BEdita frontend app can be easily enabled to serve REST API. Once enabled the API present a set of default endpoints that can be customized for frontend needs.

REST API¶

  • Setup a frontend to consume API
    • Enable API on new frontend app
    • Enable API on old frontend app
  • Configuration
  • Response and Errors
    • Response
    • Errors
  • Authentication
    • Key concepts
    • Architecture
    • Customize authentication
  • Pagination
    • Define your API pagination default options
    • Paginate objects in custom endpoints
  • Customize endpoints
    • Custom endpoints
    • Blacklist endpoints
    • Enable special object types endpoints
    • Setup query string parameters
    • Customize /objects endpoint
  • Formatting BEdita objects
    • Introducing the ApiFormatter Component
    • Help ApiFormatter to cast object fields in the right way
    • Remove unwanted fields
    • Keep fields that are removed by default
  • API reference
    • Authentication /auth
    • Objects /objects
    • Posters /posters
    • User profile /me

Indices and tables¶

  • Index
  • HTTP Routing Table
Next

© Copyright 2015, Channelweb Srl, Chialab Srl. Revision 7ddc8d4c.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: v3.7.0
Versions
latest
stable
v3.7.0
v3.6.0
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.