plone.restapi: A RESTful hypermedia API for Plone.

Contents

https://secure.travis-ci.org/plone/plone.restapi.png?branch=master https://coveralls.io/repos/github/plone/plone.restapi/badge.svg?branch=master Code Health https://readthedocs.org/projects/pip/badge https://img.shields.io/pypi/v/plone.restapi.svg

Introduction

plone.restapi is a RESTful hypermedia API for Plone.

Getting started

A live demo of Plone 5 with the latest plone.restapi release is available at:

http://plonedemo.kitconcept.com

Example GET request on the portal root:

$ curl -i https://plonedemo.kitconcept.com -H "Accept: application/json"

Example POST request to create a new document:

$ curl -i -X POST https://plonedemo.kitconcept.com -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"@type": "Document", "title": "My Document"}' --user admin:admin

Note

You will need some kind of API browser application to explore the API. We recommend using Postman.

Installation

Install plone.restapi by adding it to your buildout:

[buildout]

...

eggs =
    plone.restapi

and then running bin/buildout

Examples

plone.restapi is used in production since the first alpha release. It can be seen in action at the following sites:

Support

If you are having issues, please let us know via the issue tracker.

If you required professional support, here is a list of Plone solution providers that contributed significantly to plone.restapi in the past:

License

The project is licensed under the GPLv2.

Appendix, Indices and tables