wordpress rest api 参数详解及授权处理

当前位置: 首页 » 文章 » WordPress » wordpress rest api 参数详解及授权处理

分类: WordPress 480阅读阅读模式

一般对于 wp-json 来说, ["POST", "PUT", "PATCH", "DELETE"]都需要授权,目前(4.1版本)暂时没有授权方案, 只能依靠第三方插件处理授权问题。授权处理请查看 WordPress 使用 JWT Authentication 或 Nonces 验证 WordPress REST API

而 GET 则大部分不需要授权,如果涉及到用户信息或后天配置信息,这些获取仍需要授权。

AJAX 的形式获取 JSON 数据有网站信息、用户信息、文章信息、评论信息、目录信息、标签信息、单页面信息、分类信息、媒体信息,全部参数链接详解如文章内容;

 

0 网站信息

  1. https://wordpress.crlang.com/wp-json

 

 

1 文章

1.1 获取最新文章(默认获取到最新的10篇文章)

  1. https://wordpress.crlang.com/wp-json/wp/v2/posts

GET  参数如下:

  1. "context": {
  2.   "default": "view",
  3.   "enum": ["view", "embed", "edit"],
  4.   "description": "请求提出的范围,用于决定回应包含的字段。",
  5.   "type": "string"
  6. }, "page": {
  7.   "default": 1,
  8.   "description": "集合的当前页。",
  9.   "type": "integer"
  10. }, "per_page": {
  11.   "default": 10,
  12.   "description": "结果集包含的最大项目数量。",
  13.   "type": "integer"
  14. }, "search": {
  15.   "description": "将结果限制为匹配字符串的。",
  16.   "type": "string"
  17. }, "after": {
  18.   "description": "将回应限制在一个给定的ISO8601兼容日期之后发布的文章。",
  19.   "type": "string"
  20. }, "author": {
  21.   "default": [],
  22.   "description": "限制结果集为指定给特定作者的文章。",
  23.   "type": "array",
  24. }, "author_exclude": {
  25.   "default": [],
  26.   "description": "确保结果集排除指定给特定作者的文章。",
  27.   "type": "array",
  28. }, "before": {
  29.   "description": "将回应限制在一个给定的ISO8601兼容日期之前发布的文章。",
  30.   "type": "string"
  31. }, "exclude": {
  32.   "default": [],
  33.   "description": "确保结果集排除指定ID。",
  34.   "type": "array",
  35. }, "include": {
  36.   "default": [],
  37.   "description": "将结果集限制到指定ID。",
  38.   "type": "array",
  39. }, "offset": {
  40.   "description": "将结果集移位特定数量。",
  41.   "type": "integer"
  42. }, "order": {
  43.   "default": "desc",
  44.   "enum": ["asc", "desc"],
  45.   "description": "设置排序字段升序或降序。",
  46.   "type": "string"
  47. }, "orderby": {
  48.   "default": "date",
  49.   "enum": ["author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title"],
  50.   "description": "按对象属性排序集合。",
  51.   "type": "string"
  52. }, "slug": {
  53.   "description": "限制结果集为有一个或多个特定别名的文章。",
  54.   "type": "array",
  55. }, "status": {
  56.   "default": "publish",
  57.   "description": "限制结果集为有一个或多个状态的文章。",
  58.   "type": "array",
  59.   "items": {
  60.     "enum": ["publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "any"],
  61.     "type": "string"
  62.   }
  63. }, "categories": {
  64.   "default": [],
  65.   "description": "限制结果集为在categories分类法中指定了特定项目的项目。",
  66.   "type": "array",
  67. }, "categories_exclude": {
  68.   "default": [],
  69.   "description": "限制结果集为在categories分类法中没有指定特定项目的项目。",
  70.   "type": "array",
  71. }, "tags": {
  72.   "default": [],
  73.   "description": "限制结果集为在tags分类法中指定了特定项目的项目。",
  74.   "type": "array",
  75. }, "tags_exclude": {
  76.   "default": [],
  77.   "description": "限制结果集为在tags分类法中没有指定特定项目的项目。",
  78.   "type": "array",
  79. }, "sticky": {
  80.   "description": "限制结果集为置顶项目。",
  81.   "type": "boolean"
  82. }

示例:如获取第三页

  1. https://wordpress.crlang.com/wp-json/wp/v2/posts?page=3&per_page=10

POST (需要授权,会修改数据)参数如下:

  1. "args": {
  2.   "date": {
  3.     "description": "对象的发布时间,站点时区。",
  4.     "type": "string"
  5.   },
  6.   "date_gmt": {
  7.     "description": "对象的发布时间,GMT。",
  8.     "type": "string"
  9.   },
  10.   "slug": {
  11.     "description": "对象类别而言的英数字标识符。",
  12.     "type": "string"
  13.   },
  14.   "status": {
  15.     "enum": ["publish", "future", "draft", "pending", "private"],
  16.     "description": "对象的命名状态。",
  17.     "type": "string"
  18.   },
  19.   "password": {
  20.     "description": "用来保护内容和摘要的密码。",
  21.     "type": "string"
  22.   },
  23.   "title": {
  24.     "description": "对象的标题。",
  25.     "type": "object"
  26.   },
  27.   "content": {
  28.     "description": "对象的内容。",
  29.     "type": "object"
  30.   },
  31.   "author": {
  32.     "description": "对象作者的ID。",
  33.     "type": "integer"
  34.   },
  35.   "excerpt": {
  36.     "description": "对象的摘要。",
  37.     "type": "object"
  38.   },
  39.   "featured_media": {
  40.     "description": "对象的特色媒体ID。",
  41.     "type": "integer"
  42.   },
  43.   "comment_status": {
  44.     "enum": ["open", "closed"],
  45.     "description": "对象是否开放评论。",
  46.     "type": "string"
  47.   },
  48.   "ping_status": {
  49.     "enum": ["open", "closed"],
  50.     "description": "对象是否接受ping。",
  51.     "type": "string"
  52.   },
  53.   "format": {
  54.     "enum": ["standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio"],
  55.     "description": "对象的格式。",
  56.     "type": "string"
  57.   },
  58.   "meta": {
  59.     "description": "元字段。",
  60.     "type": "object"
  61.   },
  62.   "sticky": {
  63.     "description": "对象是否是置顶的。",
  64.     "type": "boolean"
  65.   },
  66.   "template": {
  67.     "description": "用来显示此对象的主题文件。",
  68.     "type": "string"
  69.   },
  70.   "categories": {
  71.     "description": "此对象在category分类法中指定的项目。",
  72.     "type": "array",
  73.   },
  74.   "tags": {
  75.     "description": "此对象在post_tag分类法中指定的项目。",
  76.     "type": "array",
  77.   }
  78. }

 

 

1.2 获取指定ID的文章数据

  1. https://wordpress.crlang.com/wp-json/wp/v2/posts/123

GET 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "对象的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "context": {
  7.     "default": "view",
  8.     "enum": ["view", "embed", "edit"],
  9.     "description": "请求提出的范围,用于决定回应包含的字段。",
  10.     "type": "string"
  11.   },
  12.   "password": {
  13.     "description": "该文章的密码,如文章受密码保护。",
  14.     "type": "string"
  15.   }
  16. }

示例:如获取加密的文章

  1. https://wordpress.crlang.com/wp-json/wp/v2/posts/666?password=123

POST 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "对象的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "date": {
  7.     "description": "对象的发布时间,站点时区。",
  8.     "type": "string"
  9.   },
  10.   "date_gmt": {
  11.     "description": "对象的发布时间,GMT。",
  12.     "type": "string"
  13.   },
  14.   "slug": {
  15.     "description": "对象类别而言的英数字标识符。",
  16.     "type": "string"
  17.   },
  18.   "status": {
  19.     "enum": ["publish", "future", "draft", "pending", "private"],
  20.     "description": "对象的命名状态。",
  21.     "type": "string"
  22.   },
  23.   "password": {
  24.     "description": "用来保护内容和摘要的密码。",
  25.     "type": "string"
  26.   },
  27.   "title": {
  28.     "description": "对象的标题。",
  29.     "type": "object"
  30.   },
  31.   "content": {
  32.     "description": "对象的内容。",
  33.     "type": "object"
  34.   },
  35.   "author": {
  36.     "description": "对象作者的ID。",
  37.     "type": "integer"
  38.   },
  39.   "excerpt": {
  40.     "description": "对象的摘要。",
  41.     "type": "object"
  42.   },
  43.   "featured_media": {
  44.     "description": "对象的特色媒体ID。",
  45.     "type": "integer"
  46.   },
  47.   "comment_status": {
  48.     "enum": ["open", "closed"],
  49.     "description": "对象是否开放评论。",
  50.     "type": "string"
  51.   },
  52.   "ping_status": {
  53.     "enum": ["open", "closed"],
  54.     "description": "对象是否接受ping。",
  55.     "type": "string"
  56.   },
  57.   "format": {
  58.     "enum": ["standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio"],
  59.     "description": "对象的格式。",
  60.     "type": "string"
  61.   },
  62.   "meta": {
  63.     "description": "元字段。",
  64.     "type": "object"
  65.   },
  66.   "sticky": {
  67.     "description": "对象是否是置顶的。",
  68.     "type": "boolean"
  69.   },
  70.   "template": {
  71.     "description": "用来显示此对象的主题文件。",
  72.     "type": "string"
  73.   },
  74.   "categories": {
  75.     "description": "此对象在category分类法中指定的项目。",
  76.     "type": "array",
  77.   },
  78.   "tags": {
  79.     "description": "此对象在post_tag分类法中指定的项目。",
  80.     "type": "array",
  81.   }
  82. }

DELETE (需要授权,删除动作)参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "对象的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "force": {
  7.     "default": false,
  8.     "description": "是否绕过回收站并强行删除。",
  9.     "type": "boolean"
  10.   }
  11. }

 

 

1.3 获取指定ID的文章所有的修订版数据

  1. https://wordpress.crlang.com/wp-json/wp/v2/posts/123/revisions

GET 参数如下:

  1. "args": {
  2.   "parent": {
  3.     "description": "对象的父对象ID。",
  4.     "type": "integer"
  5.   },
  6.   "context": {
  7.     "default": "view",
  8.     "enum": ["view", "embed", "edit"],
  9.     "description": "请求提出的范围,用于决定回应包含的字段。",
  10.     "type": "string"
  11.   }
  12. }

 

 

1.4 获取指定ID的文章指定修订ID的数据

  1. https://wordpress.crlang.com/wp-json/wp/v2/posts/123/revisions/66

GET 参数如下:

  1. "args": {
  2.   "parent": {
  3.     "description": "对象的父对象ID。",
  4.     "type": "integer"
  5.   },
  6.   "id": {
  7.     "description": "对象的唯一标识符。",
  8.     "type": "integer"
  9.   },
  10.   "context": {
  11.     "default": "view",
  12.     "enum": ["view", "embed", "edit"],
  13.     "description": "请求提出的范围,用于决定回应包含的字段。",
  14.     "type": "string"
  15.   }
  16. }

DELETE 参数如下:

  1. "args": {
  2.   "parent": {
  3.     "description": "对象的父对象ID。",
  4.     "type": "integer"
  5.   },
  6.   "id": {
  7.     "description": "对象的唯一标识符。",
  8.     "type": "integer"
  9.   },
  10.   "force": {
  11.     "default": false,
  12.     "description": "要求为true,因为修订版本不能被移动到回收站。",
  13.     "type": "boolean"
  14.   }
  15. }

示例:如删除 id 为 123 的第 6 次的修改稿

  1. DELETE 模式 => https://wordpress.crlang.com/wp-json/wp/v2/posts/123/revisions/6

 

 

2 分类

2.1 获取所有分类

  1. https://wordpress.crlang.com//wp/v2/taxonomies

GET 参数如下:

  1. "args": {
  2.   "context": {
  3.     "default": "view",
  4.     "enum": ["view", "embed", "edit"],
  5.     "description": "请求提出的范围,用于决定回应包含的字段。",
  6.     "type": "string"
  7.   },
  8.   "type": {
  9.     "description": "限制结果为关联到特定文章类型的分类法。",
  10.     "type": "string"
  11.   }
  12. }

 

 

2.1 获取指定分类名称的分类信息信息

  1. https://wordpress.crlang.com//wp/v2/taxonomies/taxonomyName

GET 参数如下:

  1. "args": {
  2.   "taxonomy": {
  3.     "description": "分类法的英数字标识符。",
  4.     "type": "string"
  5.   },
  6.   "context": {
  7.     "default": "view",
  8.     "enum": ["view", "embed", "edit"],
  9.     "description": "请求提出的范围,用于决定回应包含的字段。",
  10.     "type": "string"
  11.   }
  12. }

 

 

3 目录

3.1 获取所有的目录

  1. https://wordpress.crlang.com/wp-json/wp/v2/categories

GET 参数如下:

  1. "args": {
  2.   "context": {
  3.     "default": "view",
  4.     "enum": ["view", "embed", "edit"],
  5.     "description": "请求提出的范围,用于决定回应包含的字段。",
  6.     "type": "string"
  7.   },
  8.   "page": {
  9.     "default": 1,
  10.     "description": "集合的当前页。",
  11.     "type": "integer"
  12.   },
  13.   "per_page": {
  14.     "default": 10,
  15.     "description": "结果集包含的最大项目数量。",
  16.     "type": "integer"
  17.   },
  18.   "search": {
  19.     "description": "将结果限制为匹配字符串的。",
  20.     "type": "string"
  21.   },
  22.   "exclude": {
  23.     "default": [],
  24.     "description": "确保结果集排除指定ID。",
  25.     "type": "array",
  26.   },
  27.   "include": {
  28.     "default": [],
  29.     "description": "将结果集限制到指定ID。",
  30.     "type": "array",
  31.   },
  32.   "order": {
  33.     "default": "asc",
  34.     "enum": ["asc", "desc"],
  35.     "description": "设置排序字段升序或降序。",
  36.     "type": "string"
  37.   },
  38.   "orderby": {
  39.     "default": "name",
  40.     "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"],
  41.     "description": "按项目属性排序集合。",
  42.     "type": "string"
  43.   },
  44.   "hide_empty": {
  45.     "default": false,
  46.     "description": "是否隐藏未被指定到任何文章的项目。",
  47.     "type": "boolean"
  48.   },
  49.   "parent": {
  50.     "description": "限制结果集为指定给特定父项目的项目。",
  51.     "type": "integer"
  52.   },
  53.   "post": {
  54.     "description": "限制结果集为指定给特定文章的项目。",
  55.     "type": "integer"
  56.   },
  57.   "slug": {
  58.     "description": "通过设置一个或多个别名来查询指定标签。",
  59.     "type": "array",
  60.   }
  61. }

POST 参数如下:

  1. "args": {
  2.   "description": {
  3.     "description": "项目的HTML描述。",
  4.     "type": "string"
  5.   },
  6.   "name": {
  7.     "required": true,
  8.     "description": "项目的HTML标题。",
  9.     "type": "string"
  10.   },
  11.   "slug": {
  12.     "description": "项目类别而言的英数字标识符。",
  13.     "type": "string"
  14.   },
  15.   "parent": {
  16.     "description": "父项目ID。",
  17.     "type": "integer"
  18.   },
  19.   "meta": {
  20.     "description": "元字段。",
  21.     "type": "object"
  22.   }
  23. }

 

 

3.2 获取指定目录ID的目录信息

  1. https://wordpress.crlang.com/wp-json/wp/v2/categories/123

GET 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "项目的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "context": {
  7.     "default": "view",
  8.     "enum": ["view", "embed", "edit"],
  9.     "description": "请求提出的范围,用于决定回应包含的字段。",
  10.     "type": "string"
  11.   }
  12. }

POST 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "项目的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "description": {
  7.     "description": "项目的HTML描述。",
  8.     "type": "string"
  9.   },
  10.   "name": {
  11.     "description": "项目的HTML标题。",
  12.     "type": "string"
  13.   },
  14.   "slug": {
  15.     "description": "项目类别而言的英数字标识符。",
  16.     "type": "string"
  17.   },
  18.   "parent": {
  19.     "description": "父项目ID。",
  20.     "type": "integer"
  21.   },
  22.   "meta": {
  23.     "description": "元字段。",
  24.     "type": "object"
  25.   }
  26. }

DELETE 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "项目的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "force": {
  7.     "default": false,
  8.     "description": "要求为true,因为项目不能被移动到回收站。",
  9.     "type": "boolean"
  10.   }
  11. }

 

 

4 标签

4.1 获取所有的标签

  1. https://wordpress.crlang.com/wp-json/wp/v2/tags

GET 参数如下:

  1. "args": {
  2.   "context": {
  3.     "default": "view",
  4.     "enum": ["view", "embed", "edit"],
  5.     "description": "请求提出的范围,用于决定回应包含的字段。",
  6.     "type": "string"
  7.   },
  8.   "page": {
  9.     "default": 1,
  10.     "description": "集合的当前页。",
  11.     "type": "integer"
  12.   },
  13.   "per_page": {
  14.     "default": 10,
  15.     "description": "结果集包含的最大项目数量。",
  16.     "type": "integer"
  17.   },
  18.   "search": {
  19.     "description": "将结果限制为匹配字符串的。",
  20.     "type": "string"
  21.   },
  22.   "exclude": {
  23.     "default": [],
  24.     "description": "确保结果集排除指定ID。",
  25.     "type": "array",
  26.   },
  27.   "include": {
  28.     "default": [],
  29.     "description": "将结果集限制到指定ID。",
  30.     "type": "array",
  31.   },
  32.   "offset": {
  33.     "description": "将结果集移位特定数量。",
  34.     "type": "integer"
  35.   },
  36.   "order": {
  37.     "default": "asc",
  38.     "enum": ["asc", "desc"],
  39.     "description": "设置排序字段升序或降序。",
  40.     "type": "string"
  41.   },
  42.   "orderby": {
  43.     "default": "name",
  44.     "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"],
  45.     "description": "按项目属性排序集合。",
  46.     "type": "string"
  47.   },
  48.   "hide_empty": {
  49.     "default": false,
  50.     "description": "是否隐藏未被指定到任何文章的项目。",
  51.     "type": "boolean"
  52.   },
  53.   "post": {
  54.     "description": "限制结果集为指定给特定文章的项目。",
  55.     "type": "integer"
  56.   },
  57.   "slug": {
  58.     "description": "通过设置一个或多个别名来查询指定标签。",
  59.     "type": "array",
  60.   }
  61. }

POST 参数如下:

  1. "args": {
  2.   "description": {
  3.     "description": "项目的HTML描述。",
  4.     "type": "string"
  5.   },
  6.   "name": {
  7.     "required": true,
  8.     "description": "项目的HTML标题。",
  9.     "type": "string"
  10.   },
  11.   "slug": {
  12.     "description": "项目类别而言的英数字标识符。",
  13.     "type": "string"
  14.   },
  15.   "meta": {
  16.     "description": "元字段。",
  17.     "type": "object"
  18.   }
  19. }

 

 

4.2 获取指定标签ID的标签信息

  1. https://wordpress.crlang.com/wp-json/wp/v2/tags/123

GET 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "项目的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "context": {
  7.     "default": "view",
  8.     "enum": ["view", "embed", "edit"],
  9.     "description": "请求提出的范围,用于决定回应包含的字段。",
  10.     "type": "string"
  11.   }
  12. }

POST 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "项目的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "description": {
  7.     "description": "项目的HTML描述。",
  8.     "type": "string"
  9.   },
  10.   "name": {
  11.     "description": "项目的HTML标题。",
  12.     "type": "string"
  13.   },
  14.   "slug": {
  15.     "description": "项目类别而言的英数字标识符。",
  16.     "type": "string"
  17.   },
  18.   "meta": {
  19.     "description": "元字段。",
  20.     "type": "object"
  21.   }
  22. }

DELETE 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "项目的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "force": {
  7.     "default": false,
  8.     "description": "要求为true,因为项目不能被移动到回收站。",
  9.     "type": "boolean"
  10.   }
  11. }

 

 

5 媒体文件

5.1 获取所有的媒体信息

  1. https://wordpress.crlang.com/wp-json/wp/v2/media

GET 参数如下:

  1. "args": {
  2.   "context": {
  3.     "default": "view",
  4.     "enum": ["view", "embed", "edit"],
  5.     "description": "请求提出的范围,用于决定回应包含的字段。",
  6.     "type": "string"
  7.   },
  8.   "page": {
  9.     "default": 1,
  10.     "description": "集合的当前页。",
  11.     "type": "integer"
  12.   },
  13.   "per_page": {
  14.     "default": 10,
  15.     "description": "结果集包含的最大项目数量。",
  16.     "type": "integer"
  17.   },
  18.   "search": {
  19.     "description": "将结果限制为匹配字符串的。",
  20.     "type": "string"
  21.   },
  22.   "after": {
  23.     "description": "将回应限制在一个给定的ISO8601兼容日期之后发布的文章。",
  24.     "type": "string"
  25.   },
  26.   "author": {
  27.     "default": [],
  28.     "description": "限制结果集为指定给特定作者的文章。",
  29.     "type": "array",
  30.   },
  31.   "author_exclude": {
  32.     "default": [],
  33.     "description": "确保结果集排除指定给特定作者的文章。",
  34.     "type": "array",
  35.   },
  36.   "before": {
  37.     "description": "将回应限制在一个给定的ISO8601兼容日期之前发布的文章。",
  38.     "type": "string"
  39.   },
  40.   "exclude": {
  41.     "default": [],
  42.     "description": "确保结果集排除指定ID。",
  43.     "type": "array",
  44.   },
  45.   "include": {
  46.     "default": [],
  47.     "description": "将结果集限制到指定ID。",
  48.     "type": "array",
  49.   },
  50.   "offset": {
  51.     "description": "将结果集移位特定数量。",
  52.     "type": "integer"
  53.   },
  54.   "order": {
  55.     "default": "desc",
  56.     "enum": ["asc", "desc"],
  57.     "description": "设置排序字段升序或降序。",
  58.     "type": "string"
  59.   },
  60.   "orderby": {
  61.     "default": "date",
  62.     "enum": ["author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title"],
  63.     "description": "按对象属性排序集合。",
  64.     "type": "string"
  65.   },
  66.   "parent": {
  67.     "default": [],
  68.     "description": "限制结果集为一些特定父ID的项目。",
  69.     "type": "array",
  70.   },
  71.   "parent_exclude": {
  72.     "default": [],
  73.     "description": "限制结果集为没有特定父ID的文章。",
  74.     "type": "array",
  75.   },
  76.   "slug": {
  77.     "description": "限制结果集为有一个或多个特定别名的文章。",
  78.     "type": "array",
  79.   },
  80.   "status": {
  81.     "default": "inherit",
  82.     "description": "限制结果集为有一个或多个状态的文章。",
  83.     "type": "array",
  84.     "items": {
  85.       "enum": ["inherit", "private", "trash"],
  86.       "type": "string"
  87.     }
  88.   },
  89.   "media_type": {
  90.     "enum": ["image", "video", "text", "application", "audio"],
  91.     "description": "将结果集限制到某一媒体类型的附件。",
  92.     "type": "string"
  93.   },
  94.   "mime_type": {
  95.     "description": "将结果集限制到某一MIME类型的附件。",
  96.     "type": "string"
  97.   }
  98. }

POST 参数如下:

  1. "args": {
  2.   "date": {
  3.     "description": "对象的发布时间,站点时区。",
  4.     "type": "string"
  5.   },
  6.   "date_gmt": {
  7.     "description": "对象的发布时间,GMT。",
  8.     "type": "string"
  9.   },
  10.   "slug": {
  11.     "description": "对象类别而言的英数字标识符。",
  12.     "type": "string"
  13.   },
  14.   "status": {
  15.     "enum": ["publish", "future", "draft", "pending", "private"],
  16.     "description": "对象的命名状态。",
  17.     "type": "string"
  18.   },
  19.   "title": {
  20.     "description": "对象的标题。",
  21.     "type": "object"
  22.   },
  23.   "author": {
  24.     "description": "对象作者的ID。",
  25.     "type": "integer"
  26.   },
  27.   "comment_status": {
  28.     "enum": ["open", "closed"],
  29.     "description": "对象是否开放评论。",
  30.     "type": "string"
  31.   },
  32.   "ping_status": {
  33.     "enum": ["open", "closed"],
  34.     "description": "对象是否接受ping。",
  35.     "type": "string"
  36.   },
  37.   "meta": {
  38.     "description": "元字段。",
  39.     "type": "object"
  40.   },
  41.   "template": {
  42.     "description": "用来显示此对象的主题文件。",
  43.     "type": "string"
  44.   },
  45.   "alt_text": {
  46.     "description": "在附件未能显示时显示的替换文本。",
  47.     "type": "string"
  48.   },
  49.   "caption": {
  50.     "description": "附件说明。",
  51.     "type": "object"
  52.   },
  53.   "description": {
  54.     "description": "附件的描述。",
  55.     "type": "object"
  56.   },
  57.   "post": {
  58.     "description": "附件所属文章的ID。",
  59.     "type": "integer"
  60.   }
  61. }

 

 

5.2 获取指定媒体ID的媒体信息

  1. https://wordpress.crlang.com/wp-json/wp/v2/media/123

GET 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "对象的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "context": {
  7.     "default": "view",
  8.     "enum": ["view", "embed", "edit"],
  9.     "description": "请求提出的范围,用于决定回应包含的字段。",
  10.     "type": "string"
  11.   }
  12. }

POST 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "对象的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "date": {
  7.     "description": "对象的发布时间,站点时区。",
  8.     "type": "string"
  9.   },
  10.   "date_gmt": {
  11.     "description": "对象的发布时间,GMT。",
  12.     "type": "string"
  13.   },
  14.   "slug": {
  15.     "description": "对象类别而言的英数字标识符。",
  16.     "type": "string"
  17.   },
  18.   "status": {
  19.     "enum": ["publish", "future", "draft", "pending", "private"],
  20.     "description": "对象的命名状态。",
  21.     "type": "string"
  22.   },
  23.   "title": {
  24.     "description": "对象的标题。",
  25.     "type": "object"
  26.   },
  27.   "author": {
  28.     "description": "对象作者的ID。",
  29.     "type": "integer"
  30.   },
  31.   "comment_status": {
  32.     "enum": ["open", "closed"],
  33.     "description": "对象是否开放评论。",
  34.     "type": "string"
  35.   },
  36.   "ping_status": {
  37.     "enum": ["open", "closed"],
  38.     "description": "对象是否接受ping。",
  39.     "type": "string"
  40.   },
  41.   "meta": {
  42.     "description": "元字段。",
  43.     "type": "object"
  44.   },
  45.   "template": {
  46.     "description": "用来显示此对象的主题文件。",
  47.     "type": "string"
  48.   },
  49.   "alt_text": {
  50.     "description": "在附件未能显示时显示的替换文本。",
  51.     "type": "string"
  52.   },
  53.   "caption": {
  54.     "description": "附件说明。",
  55.     "type": "object"
  56.   },
  57.   "description": {
  58.     "description": "附件的描述。",
  59.     "type": "object"
  60.   },
  61.   "post": {
  62.     "description": "附件所属文章的ID。",
  63.     "type": "integer"
  64.   }
  65. }

DELETE 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "对象的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "force": {
  7.     "default": false,
  8.     "description": "是否绕过回收站并强行删除。",
  9.     "type": "boolean"
  10.   }
  11. }

 

 

6 页面

6.1 获取所有的页面信息

  1. https://wordpress.crlang.com/wp-json/wp/v2/pages

GET 参数如下:

  1. "args": {
  2.   "context": {
  3.     "default": "view",
  4.     "enum": ["view", "embed", "edit"],
  5.     "description": "请求提出的范围,用于决定回应包含的字段。",
  6.     "type": "string"
  7.   },
  8.   "page": {
  9.     "default": 1,
  10.     "description": "集合的当前页。",
  11.     "type": "integer"
  12.   },
  13.   "per_page": {
  14.     "default": 10,
  15.     "description": "结果集包含的最大项目数量。",
  16.     "type": "integer"
  17.   },
  18.   "search": {
  19.     "description": "将结果限制为匹配字符串的。",
  20.     "type": "string"
  21.   },
  22.   "after": {
  23.     "description": "将回应限制在一个给定的ISO8601兼容日期之后发布的文章。",
  24.     "type": "string"
  25.   },
  26.   "author": {
  27.     "default": [],
  28.     "description": "限制结果集为指定给特定作者的文章。",
  29.     "type": "array",
  30.   },
  31.   "author_exclude": {
  32.     "default": [],
  33.     "description": "确保结果集排除指定给特定作者的文章。",
  34.     "type": "array",
  35.   },
  36.   "before": {
  37.     "description": "将回应限制在一个给定的ISO8601兼容日期之前发布的文章。",
  38.     "type": "string"
  39.   },
  40.   "exclude": {
  41.     "default": [],
  42.     "description": "确保结果集排除指定ID。",
  43.     "type": "array",
  44.   },
  45.   "include": {
  46.     "default": [],
  47.     "description": "将结果集限制到指定ID。",
  48.     "type": "array",
  49.   },
  50.   "menu_order": {
  51.     "description": "限制结果集为有特定menu_order的文章。",
  52.     "type": "integer"
  53.   },
  54.   "offset": {
  55.     "description": "将结果集移位特定数量。",
  56.     "type": "integer"
  57.   },
  58.   "order": {
  59.     "default": "desc",
  60.     "enum": ["asc", "desc"],
  61.     "description": "设置排序字段升序或降序。",
  62.     "type": "string"
  63.   },
  64.   "orderby": {
  65.     "default": "date",
  66.     "enum": ["author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order"],
  67.     "description": "按对象属性排序集合。",
  68.     "type": "string"
  69.   },
  70.   "parent": {
  71.     "default": [],
  72.     "description": "限制结果集为一些特定父ID的项目。",
  73.     "type": "array",
  74.   },
  75.   "parent_exclude": {
  76.     "default": [],
  77.     "description": "限制结果集为没有特定父ID的文章。",
  78.     "type": "array",
  79.   },
  80.   "slug": {
  81.     "description": "限制结果集为有一个或多个特定别名的文章。",
  82.     "type": "array",
  83.   },
  84.   "status": {
  85.     "default": "publish",
  86.     "description": "限制结果集为有一个或多个状态的文章。",
  87.     "type": "array",
  88.     "items": {
  89.       "enum": ["publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "any"],
  90.       "type": "string"
  91.     }
  92.   }
  93. }

POST 参数如下:

  1. "args": {
  2.   "date": {
  3.     "description": "对象的发布时间,站点时区。",
  4.     "type": "string"
  5.   },
  6.   "date_gmt": {
  7.     "description": "对象的发布时间,GMT。",
  8.     "type": "string"
  9.   },
  10.   "slug": {
  11.     "description": "对象类别而言的英数字标识符。",
  12.     "type": "string"
  13.   },
  14.   "status": {
  15.     "enum": ["publish", "future", "draft", "pending", "private"],
  16.     "description": "对象的命名状态。",
  17.     "type": "string"
  18.   },
  19.   "password": {
  20.     "description": "用来保护内容和摘要的密码。",
  21.     "type": "string"
  22.   },
  23.   "parent": {
  24.     "description": "对象的父对象ID。",
  25.     "type": "integer"
  26.   },
  27.   "title": {
  28.     "description": "对象的标题。",
  29.     "type": "object"
  30.   },
  31.   "content": {
  32.     "description": "对象的内容。",
  33.     "type": "object"
  34.   },
  35.   "author": {
  36.     "description": "对象作者的ID。",
  37.     "type": "integer"
  38.   },
  39.   "excerpt": {
  40.     "description": "对象的摘要。",
  41.     "type": "object"
  42.   },
  43.   "featured_media": {
  44.     "description": "对象的特色媒体ID。",
  45.     "type": "integer"
  46.   },
  47.   "comment_status": {
  48.     "enum": ["open", "closed"],
  49.     "description": "对象是否开放评论。",
  50.     "type": "string"
  51.   },
  52.   "ping_status": {
  53.     "enum": ["open", "closed"],
  54.     "description": "对象是否接受ping。",
  55.     "type": "string"
  56.   },
  57.   "menu_order": {
  58.     "description": "对象相对于同类型其他对象的排序。",
  59.     "type": "integer"
  60.   },
  61.   "meta": {
  62.     "description": "元字段。",
  63.     "type": "object"
  64.   },
  65.   "template": {
  66.     "description": "用来显示此对象的主题文件。",
  67.     "type": "string"
  68.   }
  69. }

 

 

6.2 获取指定页面ID的页面信息

  1. https://wordpress.crlang.com/wp-json/wp/v2/pages/123

GET 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "对象的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "context": {
  7.     "default": "view",
  8.     "enum": ["view", "embed", "edit"],
  9.     "description": "请求提出的范围,用于决定回应包含的字段。",
  10.     "type": "string"
  11.   },
  12.   "password": {
  13.     "description": "该文章的密码,如文章受密码保护。",
  14.     "type": "string"
  15.   }
  16. }

POST 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "对象的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "date": {
  7.     "description": "对象的发布时间,站点时区。",
  8.     "type": "string"
  9.   },
  10.   "date_gmt": {
  11.     "description": "对象的发布时间,GMT。",
  12.     "type": "string"
  13.   },
  14.   "slug": {
  15.     "description": "对象类别而言的英数字标识符。",
  16.     "type": "string"
  17.   },
  18.   "status": {
  19.     "enum": ["publish", "future", "draft", "pending", "private"],
  20.     "description": "对象的命名状态。",
  21.     "type": "string"
  22.   },
  23.   "password": {
  24.     "description": "用来保护内容和摘要的密码。",
  25.     "type": "string"
  26.   },
  27.   "parent": {
  28.     "description": "对象的父对象ID。",
  29.     "type": "integer"
  30.   },
  31.   "title": {
  32.     "description": "对象的标题。",
  33.     "type": "object"
  34.   },
  35.   "content": {
  36.     "description": "对象的内容。",
  37.     "type": "object"
  38.   },
  39.   "author": {
  40.     "description": "对象作者的ID。",
  41.     "type": "integer"
  42.   },
  43.   "excerpt": {
  44.     "description": "对象的摘要。",
  45.     "type": "object"
  46.   },
  47.   "featured_media": {
  48.     "description": "对象的特色媒体ID。",
  49.     "type": "integer"
  50.   },
  51.   "comment_status": {
  52.     "enum": ["open", "closed"],
  53.     "description": "对象是否开放评论。",
  54.     "type": "string"
  55.   },
  56.   "ping_status": {
  57.     "enum": ["open", "closed"],
  58.     "description": "对象是否接受ping。",
  59.     "type": "string"
  60.   },
  61.   "menu_order": {
  62.     "description": "对象相对于同类型其他对象的排序。",
  63.     "type": "integer"
  64.   },
  65.   "meta": {
  66.     "description": "元字段。",
  67.     "type": "object"
  68.   },
  69.   "template": {
  70.     "description": "用来显示此对象的主题文件。",
  71.     "type": "string"
  72.   }
  73. }

6.3 获取指定页面ID的页面信息的所有修订版本

  1. https://wordpress.crlang.com/wp-json/wp/v2/pages/123/revisions

GET 参数如下:

  1. "args": {
  2.   "parent": {
  3.     "description": "对象的父对象ID。",
  4.     "type": "integer"
  5.   },
  6.   "context": {
  7.     "default": "view",
  8.     "enum": ["view", "embed", "edit"],
  9.     "description": "请求提出的范围,用于决定回应包含的字段。",
  10.     "type": "string"
  11.   }
  12. }

 

 

6.4 获取指定页面ID的页面信息的某个ID的修订版本

  1. https://wordpress.crlang.com/wp-json/wp/v2/pages/123/revisions/66

GET 参数如下:

  1. "args": {
  2.   "parent": {
  3.     "description": "对象的父对象ID。",
  4.     "type": "integer"
  5.   },
  6.   "id": {
  7.     "description": "对象的唯一标识符。",
  8.     "type": "integer"
  9.   },
  10.   "context": {
  11.     "default": "view",
  12.     "enum": ["view", "embed", "edit"],
  13.     "description": "请求提出的范围,用于决定回应包含的字段。",
  14.     "type": "string"
  15.   }
  16. }

DELETE 参数如下:

  1. "args": {
  2.   "parent": {
  3.     "description": "对象的父对象ID。",
  4.     "type": "integer"
  5.   },
  6.   "id": {
  7.     "description": "对象的唯一标识符。",
  8.     "type": "integer"
  9.   },
  10.   "force": {
  11.     "default": false,
  12.     "description": "要求为true,因为修订版本不能被移动到回收站。",
  13.     "type": "boolean"
  14.   }
  15. }

 

 

7 类型

7.1 获取当前wordpress所有的内容类型

  1. https://wordpress.crlang.com/wp-json/wp/v2/types

GET 参数如下:

  1. "args": {
  2.   "context": {
  3.     "default": "view",
  4.     "enum": ["view", "embed", "edit"],
  5.     "description": "请求提出的范围,用于决定回应包含的字段。",
  6.     "type": "string"
  7.   }
  8. }

 

 

7.2 获取指定类型

  1. https://wordpress.crlang.com/wp-json/wp/v2/types/typeName

GET 参数如下:

  1. "args": {
  2.   "type": {
  3.     "description": "文章类别的英数字标识符。",
  4.     "type": "string"
  5.   },
  6.   "context": {
  7.     "default": "view",
  8.     "enum": ["view", "embed", "edit"],
  9.     "description": "请求提出的范围,用于决定回应包含的字段。",
  10.     "type": "string"
  11.   }
  12. }

 

 

8 评论

8.1 获取所有评论信息

  1. https://wordpress.crlang.com/wp-json/wp/v2/comments

GET 参数如下:

  1. "args": {
  2.   "context": {
  3.     "default": "view",
  4.     "enum": ["view", "embed", "edit"],
  5.     "description": "请求提出的范围,用于决定回应包含的字段。",
  6.     "type": "string"
  7.   },
  8.   "page": {
  9.     "default": 1,
  10.     "description": "集合的当前页。",
  11.     "type": "integer"
  12.   },
  13.   "per_page": {
  14.     "default": 10,
  15.     "description": "结果集包含的最大项目数量。",
  16.     "type": "integer"
  17.   },
  18.   "search": {
  19.     "description": "将结果限制为匹配字符串的。",
  20.     "type": "string"
  21.   },
  22.   "after": {
  23.     "description": "将回应限制在一个给定的ISO8601兼容日期之后发布的评论。",
  24.     "type": "string"
  25.   },
  26.   "author": {
  27.     "description": "将结果集限制在指定给特定用户ID的评论,需要授权。",
  28.     "type": "array",
  29.   },
  30.   "author_exclude": {
  31.     "description": "确保结果集排除指定给特定用户ID的评论,需要授权。",
  32.     "type": "array",
  33.   },
  34.   "author_email": {
  35.     "description": "将结果集限制为指定作者电子邮件地址,需要授权。",
  36.     "type": "string"
  37.   },
  38.   "before": {
  39.     "description": "将回应限制在一个给定的ISO8601兼容日期之前发布的评论。",
  40.     "type": "string"
  41.   },
  42.   "exclude": {
  43.     "default": [],
  44.     "description": "确保结果集排除指定ID。",
  45.     "type": "array",
  46.   },
  47.   "include": {
  48.     "default": [],
  49.     "description": "将结果集限制到指定ID。",
  50.     "type": "array",
  51.   },
  52.   "offset": {
  53.     "description": "将结果集移位特定数量。",
  54.     "type": "integer"
  55.   },
  56.   "order": {
  57.     "default": "desc",
  58.     "enum": ["asc", "desc"],
  59.     "description": "设置排序字段升序或降序。",
  60.     "type": "string"
  61.   },
  62.   "orderby": {
  63.     "default": "date_gmt",
  64.     "enum": ["date", "date_gmt", "id", "include", "post", "parent", "type"],
  65.     "description": "按对象属性排序集合。",
  66.     "type": "string"
  67.   },
  68.   "parent": {
  69.     "default": [],
  70.     "description": "将结果集限制为指定父ID的评论。",
  71.     "type": "array",
  72.   },
  73.   "parent_exclude": {
  74.     "default": [],
  75.     "description": "确保结果集排除指定父ID的评论。",
  76.     "type": "array",
  77.   },
  78.   "post": {
  79.     "default": [],
  80.     "description": "将结果集限制为关联到指定文章ID的评论。",
  81.     "type": "array",
  82.   },
  83.   "status": {
  84.     "default": "approve",
  85.     "description": "将结果集限制为设置特定状态的评论,需要授权。",
  86.     "type": "string"
  87.   },
  88.   "type": {
  89.     "default": "comment",
  90.     "description": "将结果集限制为设置特定类型的评论,需要授权。",
  91.     "type": "string"
  92.   },
  93.   "password": {
  94.     "description": "该文章的密码,如文章受密码保护。",
  95.     "type": "string"
  96.   }
  97. }

POST 参数如下:

  1. "args": {
  2.   "author": {
  3.     "description": "用户对象的ID,如果作者是用户。",
  4.     "type": "integer"
  5.   },
  6.   "author_email": {
  7.     "description": "对象作者的电子邮件地址。",
  8.     "type": "string"
  9.   },
  10.   "author_ip": {
  11.     "description": "对象作者的IP地址。",
  12.     "type": "string"
  13.   },
  14.   "author_name": {
  15.     "description": "对象作者的显示名。",
  16.     "type": "string"
  17.   },
  18.   "author_url": {
  19.     "description": "对象作者的URL。",
  20.     "type": "string"
  21.   },
  22.   "author_user_agent": {
  23.     "description": "对象作者的用户代理。",
  24.     "type": "string"
  25.   },
  26.   "content": {
  27.     "description": "对象的内容。",
  28.     "type": "object"
  29.   },
  30.   "date": {
  31.     "description": "对象的发布时间,站点时区。",
  32.     "type": "string"
  33.   },
  34.   "date_gmt": {
  35.     "description": "对象的发布时间,GMT。",
  36.     "type": "string"
  37.   },
  38.   "parent": {
  39.     "default": 0,
  40.     "description": "对象的父对象ID。",
  41.     "type": "integer"
  42.   },
  43.   "post": {
  44.     "default": 0,
  45.     "description": "关联文章对象的ID。",
  46.     "type": "integer"
  47.   },
  48.   "status": {
  49.     "description": "对象的状态。",
  50.     "type": "string"
  51.   },
  52.   "meta": {
  53.     "description": "元字段。",
  54.     "type": "object"
  55.   }
  56. }

 

 

8.2 获取指定评论ID的单条评论信息

  1. https://wordpress.crlang.com/wp-json/wp/v2/comments/123

GET 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "对象的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "context": {
  7.     "default": "view",
  8.     "enum": ["view", "embed", "edit"],
  9.     "description": "请求提出的范围,用于决定回应包含的字段。",
  10.     "type": "string"
  11.   },
  12.   "password": {
  13.     "description": "评论所属文章的密码(如果该文章被密码保护)。",
  14.     "type": "string"
  15.   }
  16. }

POST 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "对象的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "author": {
  7.     "description": "用户对象的ID,如果作者是用户。",
  8.     "type": "integer"
  9.   },
  10.   "author_email": {
  11.     "description": "对象作者的电子邮件地址。",
  12.     "type": "string"
  13.   },
  14.   "author_ip": {
  15.     "description": "对象作者的IP地址。",
  16.     "type": "string"
  17.   },
  18.   "author_name": {
  19.     "description": "对象作者的显示名。",
  20.     "type": "string"
  21.   },
  22.   "author_url": {
  23.     "description": "对象作者的URL。",
  24.     "type": "string"
  25.   },
  26.   "author_user_agent": {
  27.     "description": "对象作者的用户代理。",
  28.     "type": "string"
  29.   },
  30.   "content": {
  31.     "description": "对象的内容。",
  32.     "type": "object"
  33.   },
  34.   "date": {
  35.     "description": "对象的发布时间,站点时区。",
  36.     "type": "string"
  37.   },
  38.   "date_gmt": {
  39.     "description": "对象的发布时间,GMT。",
  40.     "type": "string"
  41.   },
  42.   "parent": {
  43.     "description": "对象的父对象ID。",
  44.     "type": "integer"
  45.   },
  46.   "post": {
  47.     "description": "关联文章对象的ID。",
  48.     "type": "integer"
  49.   },
  50.   "status": {
  51.     "description": "对象的状态。",
  52.     "type": "string"
  53.   },
  54.   "meta": {
  55.     "description": "元字段。",
  56.     "type": "object"
  57.   }
  58. }

DELETE 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "对象的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "force": {
  7.     "default": false,
  8.     "description": "是否绕过回收站并强行删除。",
  9.     "type": "boolean"
  10.   },
  11.   "password": {
  12.     "description": "评论所属文章的密码(如果该文章被密码保护)。",
  13.     "type": "string"
  14.   }
  15. }

 

 

9 用户

9.1 获取所有的用户信息

  1. https://wordpress.crlang.com/wp-json/wp/v2/users

GET 参数如下:

  1. "args": {
  2.   "context": {
  3.     "default": "view",
  4.     "enum": ["view", "embed", "edit"],
  5.     "description": "请求提出的范围,用于决定回应包含的字段。",
  6.     "type": "string"
  7.   },
  8.   "page": {
  9.     "default": 1,
  10.     "description": "集合的当前页。",
  11.     "type": "integer"
  12.   },
  13.   "per_page": {
  14.     "default": 10,
  15.     "description": "结果集包含的最大项目数量。",
  16.     "type": "integer"
  17.   },
  18.   "search": {
  19.     "description": "将结果限制为匹配字符串的。",
  20.     "type": "string"
  21.   },
  22.   "exclude": {
  23.     "default": [],
  24.     "description": "确保结果集排除指定ID。",
  25.     "type": "array",
  26.   },
  27.   "include": {
  28.     "default": [],
  29.     "description": "将结果集限制到指定ID。",
  30.     "type": "array",
  31.   },
  32.   "offset": {
  33.     "description": "将结果集移位特定数量。",
  34.     "type": "integer"
  35.   },
  36.   "order": {
  37.     "default": "asc",
  38.     "enum": ["asc", "desc"],
  39.     "description": "设置排序字段升序或降序。",
  40.     "type": "string"
  41.   },
  42.   "orderby": {
  43.     "default": "name",
  44.     "enum": ["id", "include", "name", "registered_date", "slug", "include_slugs", "email", "url"],
  45.     "description": "按对象属性排序集合。",
  46.     "type": "string"
  47.   },
  48.   "slug": {
  49.     "description": "通过一个或多个别名来筛选用户。",
  50.     "type": "array",
  51.   },
  52.   "roles": {
  53.     "description": "限制结果集为匹配至少一个角色的用户,接受csv列表或单个角色。",
  54.     "type": "array",
  55.   }
  56. }

POST 参数如下:

  1. "args": {
  2.   "username": {
  3.     "required": true,
  4.     "description": "用户的登录名。",
  5.     "type": "string"
  6.   },
  7.   "name": {
  8.     "description": "用户的显示名。",
  9.     "type": "string"
  10.   },
  11.   "first_name": {
  12.     "description": "用户的名。",
  13.     "type": "string"
  14.   },
  15.   "last_name": {
  16.     "description": "用户的姓。",
  17.     "type": "string"
  18.   },
  19.   "email": {
  20.     "required": true,
  21.     "description": "用户的电子邮件地址。",
  22.     "type": "string"
  23.   },
  24.   "url": {
  25.     "description": "用户的URL。",
  26.     "type": "string"
  27.   },
  28.   "description": {
  29.     "description": "用户的描述。",
  30.     "type": "string"
  31.   },
  32.   "locale": {
  33.     "enum": ["", "en_US", "zh_CN"],
  34.     "description": "用户的语言环境。",
  35.     "type": "string"
  36.   },
  37.   "nickname": {
  38.     "description": "用户的昵称。",
  39.     "type": "string"
  40.   },
  41.   "slug": {
  42.     "description": "用户的英数字标识符。",
  43.     "type": "string"
  44.   },
  45.   "roles": {
  46.     "description": "用户被赋予的角色。",
  47.     "type": "array",
  48.   },
  49.   "password": {
  50.     "required": true,
  51.     "description": "用户的密码(从不被包含)。",
  52.     "type": "string"
  53.   },
  54.   "meta": {
  55.     "description": "元字段。",
  56.     "type": "object"
  57.   }
  58. }

 

 

9.2 获取指定用户ID的用户信息

  1. https://wordpress.crlang.com/wp-json/wp/v2/users/123

GET 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "用户的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "context": {
  7.     "default": "view",
  8.     "enum": ["view", "embed", "edit"],
  9.     "description": "请求提出的范围,用于决定回应包含的字段。",
  10.     "type": "string"
  11.   }
  12. }

POST 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "用户的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "username": {
  7.     "description": "用户的登录名。",
  8.     "type": "string"
  9.   },
  10.   "name": {
  11.     "description": "用户的显示名。",
  12.     "type": "string"
  13.   },
  14.   "first_name": {
  15.     "description": "用户的名。",
  16.     "type": "string"
  17.   },
  18.   "last_name": {
  19.     "description": "用户的姓。",
  20.     "type": "string"
  21.   },
  22.   "email": {
  23.     "description": "用户的电子邮件地址。",
  24.     "type": "string"
  25.   },
  26.   "url": {
  27.     "description": "用户的URL。",
  28.     "type": "string"
  29.   },
  30.   "description": {
  31.     "description": "用户的描述。",
  32.     "type": "string"
  33.   },
  34.   "locale": {
  35.     "enum": ["", "en_US", "zh_CN"],
  36.     "description": "用户的语言环境。",
  37.     "type": "string"
  38.   },
  39.   "nickname": {
  40.     "description": "用户的昵称。",
  41.     "type": "string"
  42.   },
  43.   "slug": {
  44.     "description": "用户的英数字标识符。",
  45.     "type": "string"
  46.   },
  47.   "roles": {
  48.     "description": "用户被赋予的角色。",
  49.     "type": "array",
  50.   },
  51.   "password": {
  52.     "description": "用户的密码(从不被包含)。",
  53.     "type": "string"
  54.   },
  55.   "meta": {
  56.     "description": "元字段。",
  57.     "type": "object"
  58.   }
  59. }

DELETE 参数如下:

  1. "args": {
  2.   "id": {
  3.     "description": "用户的唯一标识符。",
  4.     "type": "integer"
  5.   },
  6.   "force": {
  7.     "default": false,
  8.     "description": "要求为true,因为用户不能被移动到回收站。",
  9.     "type": "boolean"
  10.   },
  11.   "reassign": {
  12.     "required": true,
  13.     "description": "将被删除用户的文章和链接重新指定到此用户ID。",
  14.     "type": "integer"
  15.   }
  16. }

 

 

9.3 获取我的用户信息

  1. https://wordpress.crlang.com/wp-json/wp/v2/users/me

GET 参数如下:

  1. "args": {
  2.   "context": {
  3.     "default": "view",
  4.     "enum": ["view", "embed", "edit"],
  5.     "description": "请求提出的范围,用于决定回应包含的字段。",
  6.     "type": "string"
  7.   }
  8. }

POST 参数如下:

  1. "args": {
  2.   "username": {
  3.     "description": "用户的登录名。",
  4.     "type": "string"
  5.   },
  6.   "name": {
  7.     "description": "用户的显示名。",
  8.     "type": "string"
  9.   },
  10.   "first_name": {
  11.     "description": "用户的名。",
  12.     "type": "string"
  13.   },
  14.   "last_name": {
  15.     "description": "用户的姓。",
  16.     "type": "string"
  17.   },
  18.   "email": {
  19.     "description": "用户的电子邮件地址。",
  20.     "type": "string"
  21.   },
  22.   "url": {
  23.     "description": "用户的URL。",
  24.     "type": "string"
  25.   },
  26.   "description": {
  27.     "description": "用户的描述。",
  28.     "type": "string"
  29.   },
  30.   "locale": {
  31.     "enum": ["", "en_US", "zh_CN"],
  32.     "description": "用户的语言环境。",
  33.     "type": "string"
  34.   },
  35.   "nickname": {
  36.     "description": "用户的昵称。",
  37.     "type": "string"
  38.   },
  39.   "slug": {
  40.     "description": "用户的英数字标识符。",
  41.     "type": "string"
  42.   },
  43.   "roles": {
  44.     "description": "用户被赋予的角色。",
  45.     "type": "array",
  46.   },
  47.   "password": {
  48.     "description": "用户的密码(从不被包含)。",
  49.     "type": "string"
  50.   },
  51.   "meta": {
  52.     "description": "元字段。",
  53.     "type": "object"
  54.   }
  55. }

DELETE 参数如下:

  1. "args": {
  2.   "force": {
  3.     "default": false,
  4.     "description": "要求为true,因为用户不能被移动到回收站。",
  5.     "type": "boolean"
  6.   },
  7.   "reassign": {
  8.     "required": true,
  9.     "description": "将被删除用户的文章和链接重新指定到此用户ID。",
  10.     "type": "integer"
  11.   }
  12. }

 

 

10 设置

10.1 获取网站后所有设置项

  1. https://wordpress.crlang.com//wp/v2/settings

POST 参数如下:

  1. "args": {
  2.   "title": {
  3.     "description": "站点标题。",
  4.     "type": "string"
  5.   },
  6.   "description": {
  7.     "description": "站点副标题。",
  8.     "type": "string"
  9.   },
  10.   "url": {
  11.     "description": "站点URL。",
  12.     "type": "string"
  13.   },
  14.   "email": {
  15.     "description": "此地址被用作管理用途,如新用户通知。",
  16.     "type": "string"
  17.   },
  18.   "timezone": {
  19.     "description": "和您在同一个时区的城市。",
  20.     "type": "string"
  21.   },
  22.   "date_format": {
  23.     "description": "对所有日期字符串适用的日期格式。",
  24.     "type": "string"
  25.   },
  26.   "time_format": {
  27.     "description": "对所有时间字符串适用的时间格式。",
  28.     "type": "string"
  29.   },
  30.   "start_of_week": {
  31.     "description": "一周从周几开始。",
  32.     "type": "integer"
  33.   },
  34.   "language": {
  35.     "description": "WordPress地区代码。",
  36.     "type": "string"
  37.   },
  38.   "use_smilies": {
  39.     "description": "将表情符号如:-)和:-P转换为图片显示。",
  40.     "type": "boolean"
  41.   },
  42.   "default_category": {
  43.     "description": "默认文章类别。",
  44.     "type": "integer"
  45.   },
  46.   "default_post_format": {
  47.     "description": "默认文章格式。",
  48.     "type": "string"
  49.   },
  50.   "posts_per_page": {
  51.     "description": "最多显示的博客页面数量。",
  52.     "type": "integer"
  53.   },
  54.   "default_ping_status": {
  55.     "enum": ["open", "closed"],
  56.     "description": "允许其他博客发送链接通知(pingback和trackback)到新文章。",
  57.     "type": "string"
  58.   },
  59.   "default_comment_status": {
  60.     "enum": ["open", "closed"],
  61.     "description": "允许他人在新文章上发表评论。",
  62.     "type": "string"
  63.   }
  64. }

 

备注:一般 context 是指直接返回数据,不需要额外参数;

 

完毕!

相关文章