RESTful hypermedia API for Plone.
Branch: master
Clone or download
Latest commit 8f8446d Feb 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs/source Pin sphinxcontrib-httpexample==0.9.1 in readthedocs-requirements.txt: Oct 21, 2018
news Improve wording for #671 changelog. Feb 16, 2019
src/plone Move tests from test_deserialize_siteroot.py to test_site_deserialize… Feb 16, 2019
.coveragerc There's no point in measuring the coverage of test modules. Mar 4, 2017
.editorconfig Don't remove whitespace in .resp files. Apr 20, 2017
.gitignore gitignore mypy cache Oct 3, 2018
.isort.cfg Update to latest plone releases (4.3.17, 5.1.2); remove old buildout … Jun 23, 2018
.landscape.yml Make landscape ignore pylint inherit-non-class. Jul 11, 2015
.travis.yml Test py 3.7 on Travis. Jan 20, 2019
CHANGES.rst Back to development: 3.6.1 Feb 16, 2019
CONTRIBUTORS.rst Clean up README and follow best practices. Nov 2, 2018
Dockerfile Install git on Dokcerfile which is needed for the mr.developer auto-c… Jun 3, 2017
Jenkinsfile Revert "Mv jmeter.csv -> jmeter.jtl." Jan 8, 2018
MANIFEST.in Revert "Revert "Initialize towncrier"" Feb 15, 2019
Makefile Add make build-py3. Nov 18, 2018
README.rst Remove trailing slashes in README. Feb 10, 2019
base.cfg Preparing release 3.6.0 Feb 16, 2019
buildout.cfg Update to latest plone releases (4.3.17, 5.1.2); remove old buildout … Jun 23, 2018
heroku.cfg heroku: do not pin pytz. Aug 15, 2016
performance.jmx Upgrade to jmeter 5.0 and fix creating image and news item in perform… Feb 5, 2019
plone-4.3.x-performance.cfg Upgrade to jmeter 5.0 and fix creating image and news item in perform… Feb 5, 2019
plone-4.3.x.cfg Upgrade to Plone 4.3.18. Nov 18, 2018
plone-5.0.x-performance.cfg Upgrade to jmeter 5.0 and fix creating image and news item in perform… Feb 5, 2019
plone-5.0.x.cfg Test against Plone 5.0.10. Feb 9, 2019
plone-5.1.x-performance.cfg Upgrade to jmeter 5.0 and fix creating image and news item in perform… Feb 5, 2019
plone-5.1.x.cfg Upgrade to Plone 5.1.5. Feb 5, 2019
plone-5.2.x.cfg Upgrade Plone to 5.2a2. Jan 8, 2019
pyproject.toml Revert "Revert "Initialize towncrier"" Feb 15, 2019
requirements.txt Link to Plone 5.2 requirements.txt. Nov 13, 2018
setup.cfg Release as universal (Py2/3 compatible) wheel. Feb 6, 2019
setup.py Back to development: 3.6.1 Feb 16, 2019
site.cfg Dockerfile: create instance and cors policy. Jul 6, 2017
swagger-siteroot.yaml initial basic swagger yaml May 17, 2016
test-no-sphinx-warnings.in Skip Sphinx warnings for Plone 5.2. Nov 18, 2018
test-no-uncommitted-doc-changes.in Exclude Plone 5.2.x from checking uncommitted doc changes. Nov 1, 2018
travis.cfg Remove createcoverage section from travis.cfg. May 27, 2017
versions.cfg Add zestreleaser.towncrier and make sure we us the same version pins … Feb 16, 2019

README.rst

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

Introduction

plone.restapi is a RESTful hypermedia API for Plone.

Documentation

http://plonerestapi.readthedocs.org

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 http://plonedemo.kitconcept.com -H "Accept: application/json"

Example POST request to create a new document:

$ curl -i -X POST http://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

Contribute

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.