联邦与接口

每个站点是一个节点,节点的身份就是它的网址。节点之间不共用数据库,只通过 HTTP 交换 JSON 格式的「信封」。任何人都可以运行自己的节点。

发现

每类节点在固定的网址上放一份发现文档,说明自己是什么、支持哪些语言、接口在哪里:

节点网址
菜品库/.well-known/canyin-dish-hub
餐馆节点/.well-known/canyin-venue
供销站点/.well-known/canyin-supply-hub
推荐菜品库/.well-known/caipin-library
发现文档

发现文档需要站点启用固定链接;没有启用时接口本身仍然可用。

公开接口

接口内容
sxck/v1/dishes菜品检索:关键词、类别、菜系、分页
sxck/v1/dish/{代号}一道菜的信封,含配料表;可取 JSON-LD
sxck/v1/ingredients食材主库
sxck/v1/categories菜品类别
sxgx/v1/supply供应目录检索:种类、类别、关键词、分页
sxcy/v1/menu一家餐馆的多语言菜单
主要的只读接口(WordPress REST)

写入与审核

  • 向菜品库或供销站点贡献条目:先进审核队列,由该站的运营者接受或拒绝;可以关闭公开贡献。
  • 餐馆的物资需求:缺省不发布;发布时带访问令牌。
  • 餐馆的管理接口(建店、菜品、菜单、桌台、订单):要用应用密码认证,会员只能操作自己名下的餐馆。

数据的命名空间

以 JSON-LD 输出时,问道餐饮自有的词汇用命名空间 https://dishes.reresearch.org/canyin/ns#。

本页是概要。完整的字段与接口说明随各插件发布。〔技术手册的网址〕

AI 助手