3.3. API资源

API资源包含RESTCONF数据存储和操作资源的RESTCONF根资源。它是位于{+restconf}的顶级资源，具有媒体类型“application/yang-data+xml”或“application/yang-data+json”。

API资源的YANG树图：

  1. +---- {+restconf}
  2.       +---- data
  3.       | ...
  4.       +---- operations?
  5.       | ...
  6.       +--ro yang-library-version    string

“yang-api”的YANG数据模板使用第8节中的“ietf-restconf”模块中的“yang-data”扩展定义。它指定了API资源中概念子资源的结构和语法。

可以使用GET方法来检索API资源。

表示“ietf-restconf”模块根目录的响应中使用的{+restconf}根资源名必须标识“ietf-restconf”的YANG模块。例如，以JSON格式获取根资源“/restconf”的请求将返回名为“ietf-restconf:restconf”的API资源的表示。

此资源具有以下子资源：

RESTCONF API Resource

子资源 说明
data 包含所有数据资源
operations 特定于数据模型的操作
yang-library-version “ietf-yang-library”模块日期

RFC8040 RESTCONF API Resource 原表

  1. +----------------------+---------------------------------+
  2. | Child Resource       | Description                     |
  3. +----------------------+---------------------------------+
  4. | data                 | Contains all data resources     |
  5. | operations           | Data-model-specific operations  |
  6. | yang-library-version | "ietf-yang-library" module date |
  7. +----------------------+---------------------------------+