Skip to content

plone/plone.restapi

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Sep 21, 2023
4e0e300 · Sep 21, 2023
Sep 21, 2023
Dec 29, 2021
Sep 21, 2023
Aug 28, 2020
Sep 4, 2023
Mar 4, 2017
Apr 20, 2017
Apr 30, 2021
Feb 5, 2021
Jun 23, 2018
Jul 11, 2015
Sep 21, 2023
Oct 25, 2019
May 6, 2020
Jun 3, 2017
Mar 20, 2021
Sep 21, 2023
Jan 7, 2022
May 4, 2022
Sep 14, 2021
Sep 6, 2021
Dec 18, 2020
Aug 15, 2016
May 4, 2020
Feb 5, 2019
Apr 19, 2023
Feb 5, 2019
Nov 24, 2021
Sep 6, 2021
Mar 31, 2023
Jan 5, 2022
Nov 25, 2021
Sep 21, 2023
Jul 6, 2017
May 17, 2016
Sep 10, 2019
Mar 24, 2021
Mar 31, 2023
May 6, 2020
Mar 21, 2020

Repository files navigation

https://coveralls.io/repos/github/plone/plone.restapi/badge.svg?branch=master https://readthedocs.org/projects/pip/badge

Introduction

plone.restapi is a RESTful hypermedia API for Plone.

Documentation

https://plonerestapi.readthedocs.org

Getting started

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

https://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

When installing plone.restapi version 7.x.x in Plone 4 you may need to add the following version pins to your buildout:

[versions]
PyJWT = 1.7.1

six = 1.11.0
attrs = 21.2.0
plone.rest = 1.6.2
plone.schema = 1.3.0
# Last pyrsistent version that is python 2 compatible:
pyrsistent = 0.15.7

# Required by:
# jsonschema==3.2.0
functools32 = 3.2.3.post2

# Required by:
# plone.schema==1.3.0
jsonschema = 3.2.0

# Required by:
# importlib-metadata==1.3.0
pathlib2 = 2.3.5

# Required by:
# pathlib2==2.3.5
scandir = 1.10.0

# plone.app.contenttypes > 1.0
plone.app.contenttypes = 1.1.9

importlib-metadata = 2.1.3
zipp = 1.2.0
configparser = 4.0.2
contextlib2 = 0.6.0.post1

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.