提供查询网站导航树的REST端点
项目描述
此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": "https://:8080/Plone/@navigationtree",
"items": [
{
"@id": "https://:8080/Plone",
"description": "",
"items": "",
"title": "Home"
},
{
"@id": "https://:8080/Plone/news",
"description": "Site News",
"items": [
{
"@id": "https://:8080/Plone/news/some-news",
"description": "",
"title": "Some News"
}
],
"title": "News"
},
{
"@id": "https://:8080/Plone/events",
"description": "Site Events",
"items": [],
"title": "Events"
},
{
"@id": "https://: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许可。
贡献者
Fulvio Casali,fulviocasali@gmail.com
变更日志
1.0a1 (2018-03-12)
初始版本。[fulv]
项目详情
collective.restapi.navigationtree-1.0a1.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 805eff65f58fd1ac3d20997b7fc5a374664c92c7b13659ab5df5993c7e5bc05b |
|
| MD5 | 395fbeb1efbedc2c3cd5043bb6f13580 |
|
| BLAKE2b-256 | ff3606e1174a6934983f8a525c5e397cefa001626ad99a7dc3ff6a1ff7eececa |