跳转到主要内容

提供查询网站导航树的REST端点

项目描述

http://img.shields.io/pypi/v/collective.restapi.navigationtree.svg https://img.shields.io/travis/collective/collective.restapi.navigationtree/master.svg https://img.shields.io/coveralls/collective/collective.restapi.navigationtree/master.svg

此Plone插件提供查询网站导航树的REST端点。端点名称为@navigationtree,可以看作是plone.restapi@navigation端点的扩展,因为后者只返回顶级导航菜单项。collective.restapi.navigationtree依赖于webcouturier.dropdownmenu插件来构建导航树,并遵守与webcouturier.dropdownmenu相同的配置设置。因此,可以在webcouturier.dropdownmenu配置集中设置树的最大深度。

已在Plone 4.3、5.0和5.1上使用Archetypes和Dexterity进行测试。

功能

  • 简单GET @navigationtree

  • 通过构建整个网站导航树,扩展了plone.restapi@navigation端点,而不仅仅是限制在顶级导航菜单中。

  • 依赖于 webcouturier.dropdownmenu,因此非常适合已经使用此插件进行导航菜单的网站。

  • 尊重Plone的“导航”控制面板中的所有配置设置。

  • 尊重@@dropdown-controlpanel中的所有配置设置。

  • 特别是,您可以在webcouturier.dropdownmenu的配置集中设置导航树的深度。

示例

获取导航树

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

(授权是可选的。)

示例响应

{
    "@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"
        }
    ]
}

安装

通过将其添加到您的buildout中安装collective.restapi.navigationtree

[buildout]

...

eggs =
    collective.restapi.navigationtree

然后运行bin/buildout。这将自动安装webcouturier.dropdownmenu和plone.restapi,因此您应该根据运行的Plone版本锁定这些扩展程序的版本。

贡献

支持

如果您遇到问题,请在问题跟踪器中告诉我们。

许可协议

本项目采用GPLv2许可。

贡献者

变更日志

1.0a1 (2018-03-12)

  • 初始版本。[fulv]

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解有关安装软件包的更多信息。

源代码发行版

collective.restapi.navigationtree-1.0a1.tar.gz (11.5 kB 查看哈希值)

上传时间:

由以下机构支持