Introduction
This is an add-on package for plone.jsonapi.core which provides some basic URLs for
Plone standard contents (and more).
Motivation
The routes package is built on top of the plone.jsonapi.core package to allow Plone
developers to build modern (JavaScript) web UIs which communicate through a RESTful
API with their Plone site.
Compatibility
The plone.jsonapi.routes should work with Plone 3 and 4.
API URL
After installation, the Plone API routes are available below the plone.jsonapi.core
root URL (@@API) with the base /plone/api/1.0, for example
http://localhost:8080/Plone/@@API/plone/api/1.0/api.json.
There is also an overview of the registered routes which can be accessed here:
http://localhost:8080/Plone/@@API/plone/api/1.0/api.json
API Routes
BASE_URL: /plone/api/1.0
This is an overview of the provided API Routes. The basic content routes provide all an
interface for CRUD operations.
CRUD URL Scheme:
OPERATION URL METHOD PAYLOAD
VIEW // GET --
CREATE //create/ POST JSON
UPDATE //update/ POST JSON
DELETE //delete/ POST JSON
|