Skip to content
Provides a REST endpoint to query the site's navigation tree
Python Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
src/collective
.coveragerc
.editorconfig
.gitattributes
.gitignore
.travis.yml
CHANGES.rst
CONTRIBUTORS.rst
DEVELOP.rst
LICENSE.GPL
LICENSE.rst
MANIFEST.in
README.rst
bobtemplate.cfg
buildout.cfg
requirements.txt
setup.cfg
setup.py
versions-4.3.x.cfg
versions-5.0.x.cfg
versions-5.1.x.cfg

README.rst

collective.restapi.navigationtree

This Plone plugin provides a REST endpoint to query the site's navigation tree. The endpoint name is @navigationtree, and can be considered an extension to plone.restapi's @navigation endpoint, since the latter only returns the top level navigation menu items. collective.restapi.navigationtree depends on the webcouturier.dropdownmenu plugin to build the navigation tree, and honors the same configuration settings as webcouturier.dropdownmenu. Thus, the maximum depth of the tree can be set in the webcouturier.dropdownmenu configlet.

Tested on Plone 4.3, 5.0 and 5.1 with Archetypes and Dexterity.

Features

  • Simply GET @navigationtree
  • Extends the @navigation endpoint of plone.restapi by building a full navigation tree of the site, instead of limiting itself to just the top level navigation menu.
  • Depends on webcouturier.dropdownmenu, thus is ideal for sites that already use this plugin for their navigation menu.
  • Honors all the configuration settings in Plone's _Navigation_ control panel.
  • Honors all the configuration settings in @@dropdown-controlpanel.
  • In particular, you can set the depth of the navigation tree in webcouturier.dropdownmenu's configlet.

Examples

Getting the navigation tree:

GET /plone/@navigationtree HTTP/1.1
Accept: application/json
Authorization: Basic YWRtaW46c2VjcmV0

(Authorization is optional.)

Example response:

{
    "@id": "http://localhost:8080/Plone/@navigationtree",
    "items": [
        {
            "@id": "http://localhost:8080/Plone",
            "description": "",
            "items": "",
            "title": "Home"
        },
        {
            "@id": "http://localhost:8080/Plone/news",
            "description": "Site News",
            "items": [
                {
                    "@id": "http://localhost:8080/Plone/news/some-news",
                    "description": "",
                    "title": "Some News"
                }
            ],
            "title": "News"
        },
        {
            "@id": "http://localhost:8080/Plone/events",
            "description": "Site Events",
            "items": [],
            "title": "Events"
        },
        {
            "@id": "http://localhost:8080/Plone/Members",
            "description": "Site Users",
            "items": [],
            "title": "Users"
        }
    ]
}

Installation

Install collective.restapi.navigationtree by adding it to your buildout:

[buildout]

...

eggs =
    collective.restapi.navigationtree

and then running bin/buildout. This will automatically install webcouturier.dropdownmenu and plone.restapi, so you should pin the versions of these add-ons according to the version of Plone you are running.

Contribute

Support

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

License

The project is licensed under the GPLv2.

You can’t perform that action at this time.