wordpress插件WP Rest API接口文档说明
详细说明请看说明手册:
https://developer.wordpress.org/rest-api/reference/
资源资源 | 基本路线 |
---|---|
帖子 | /wp/v2/posts |
发布修订 | /wp/v2/posts/<id>/revisions |
分类目录 | /wp/v2/categories |
标签 | /wp/v2/tags |
页数 | /wp/v2/pages |
页面修订 | /wp/v2/pages/<id>/revisions |
评论 | /wp/v2/comments |
分类法 | /wp/v2/taxonomies |
媒体 | /wp/v2/media |
用户数 | /wp/v2/users |
帖子类型 | /wp/v2/types |
发布状态 | /wp/v2/statuses |
设定值 | /wp/v2/settings |
主题 | /wp/v2/themes |
搜索 | /wp/v2/search |
块类型 | /wp/v2/block-types |
积木 | /wp/v2/blocks |
块修订 | /wp/v2/blocks/<id>/autosaves/ |
块渲染器 | /wp/v2/block-renderer |
阻止目录项 | /wp/v2/block-directory/search |
外挂程式 | /wp/v2/plugins |
常用WP REST API 接口使用介绍(获取数据)
此段介绍WP REST API 常用的获取数据(GET)的接口
1、文章
(1)获取最新文章(默认获取到最新的10篇文章)
http://www.website.com/wp-json/wp/v2/posts
与
http://www.website.com/wp-json/wp/v2/posts?page=1
效果相同,page用于指定页数,WP REST API 默认返回10条数据,用page指定数据获取的游标。如
http://www.website.com/wp-json/wp/v2/posts?page=2
可取回最新的第11条数据到第20条数据,以此类推。
(2)设置获取的每页文章数量及分页
http://www.website.com/wp-json/wp/v2/posts?filter[posts_per_page]=5
filter[posts_per_page]=5 用于指定返回文章每页的数量,这里指定每页数量为5篇。
filter[posts_per_page]与page联合使用:
http://www.website.com/wp-json/wp/v2/posts?filter[posts_per_page]=5&page=2
(3)获取指定分类的文章
http://www.website.com/wp-json/wp/v2/posts?filter[cat]=2
filter[cat]=2 指定分类ID为2 ,返回分类ID为2的文章。
分类ID是每个分类目录在创建时自动生成的ID,在wordpress后台“文章”==》“分类目录”中,把鼠标放在分类名称上面,页面下方会出现一个网址,网址中的参数tag_ID=2就是这个分类名称的分类ID。如果没有出现网址,可以点击分类名称下的“编辑”,然后查看网页地址栏,同样可以得到tag_ID=2。下面的标签ID的获得方法也一样。
(4)获取指定标签的文章
http://www.website.com/wp-json/wp/v2/posts?filter[tag]=library
filter[tag]=library 指定标签名为“library”的文章
(5)获取指定分类和有指定标签的文章
http://www.website.com/wp-json/wp/v2/posts?filter[cat]=2&filter[tag]=library
上面两个结合一起,可以得到更具体精确的文章。
(6)获取指定日期的文章
http://www.website.com/wp-json/wp/v2/posts?filter[year]=2016&filter[monthnum]=03
filter[year]=2016&filter[monthnum]=03 设置指定的日期
(7)获取指定作者的文章
http://www.website.com/wp-json/wp/v2/posts?filter[author_name]=jinyun
filter[author_name]=jinyun设置指定作者名字
(8)按关键词搜索文章
http://www.website.com/wp-json/wp/v2/posts?filter[s]=金云
filter[s]=金云 :按给定的关键词搜索文章,返回包含“金云”关键词的文章。
(9)获取随机文章
http://www.website.com/wp-json/wp/v2/posts?filter[orderby]=rand
其中orderby还可以为指定的字段排序
(10)获取相关文章
在网站中,在做SEO优化和页面内容布局时,获取相关文章是比较常见的,可以通过以上几个条件组合来达到获取相关文章的效果。
按标签获取相关文章:
http://www.website.com/wp-json/wp/v2/posts?filter[orderby]=rand&filter[tag]=library&filter[posts_per_page]=6
按分类获取相关文章:
http://www.website.com/wp-json/wp/v2/posts?filter[orderby]=rand&filter[cat]=2&filter[posts_per_page]=6
(11)获取指定文章的数据
http://www.website.com/wp-json/wp/v2/posts/189
得到ID为189的文章数据
2、分类和标签
(1)获取所有的分类
http://www.website.com/wp-json/wp/v2/categories
(2)获取指定分类ID的分类信息
http://www.website.com/wp-json/wp/v2/categories/2
(3)获取所有的标签
http://www.website.com/wp-json/wp/v2/tags
(4)获取指定标签ID的标签信息
http://www.website.com/wp-json/wp/v2/tags/3
3、媒体文件
(1)获取所有的媒体信息
http://www.website.com/wp-json/wp/v2/media
(2)获取指定媒体ID的媒体信息
http://www.website.com/wp-json/wp/v2/media/17
4、页面
(1)获取所有的页面信息
http://www.website.com/wp-json/wp/v2/pages
(2)获取指定页面ID的页面信息
http://www.website.com/wp-json/wp/v2/pages/289
5、类型
(1)获取当前wordpress所有的内容类型
http://www.website.com/wp-json/wp/v2/types
一般情况下会返回post,page和attachment三种类型
(2)获取指定类型
http://www.website.com/wp-json/wp/v2/types/post
6、评论
(1)获取所有评论信息
http://www.website.com/wp-json/wp/v2/comments
(2)获取指定评论ID的单条评论信息
http://www.website.com/wp-json/wp/v2/comments/2
7、用户
(1)获取所有的用户信息
http://www.website.com/wp-json/wp/v2/users
(2)获取指定用户ID的用户信息
http://www.website.com/wp-json/wp/v2/users/1
以上即是WP REST API 内置API接口最为常用的接口数据获取方法。
wordpress插件WP Rest API接口文档说明相关推荐
- 整合swagger2生成Restful Api接口文档
整合swagger2生成Restful Api接口文档 swagger Restful文档生成工具 2017-9-30 官方地址:https://swagger.io/docs/specificati ...
- echarts4离线使用文档_适合写API接口文档的管理工具有哪些?
现在越来越流行前后端分离开发,使用ajax交互.所以api接口文档就变的十分有意义了,目前市场有哪些比较优秀的接口文档管理工具呢? 1.MinDoc 网址:https://www.iminho.me/ ...
- python生成api文档_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求 实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
- python api接口生成_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求 实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
- 盘点 8 款好用的 API 接口文档管理工具
随着互联网的普及和发展,API 接口已经无处不在.它已经在 Web 应用程序.移动应用程序.云计算.物联网.人工智能等领域中得到广泛应用. 例如,在金融行业中,API 接口可以被用于构建支付服务.银行 ...
- 如何自动生成 API 接口文档 - 一份详细指南
本篇文章详细教你如何使用 Apifox 的 IDEA 插件实现自动生成接口代码.好处简单总结有以下几点: 自动生成接口文档: 不用手写,一键点击就可以自动生成文档,当有更新时,点击一下就可以自动同步接 ...
- js学习总结----crm客户管理系统之项目开发流程和api接口文档
CRM ->客户管理系统 CMS ->内容发布管理系统 ERP ->企业战略信息管理系统 OA -> 企业办公管理系统 产品 / UI设计:需求分析,产品定位,市场调查...按 ...
- 开发日记-20190328 关键词 利用eolinker一键快速生成API接口文档
今天感觉效率真的很低= =各个层面的,apk发布到现场发现出现了问题,所以一个下午都在忙着解决现场出现的问题,领导一直打电话询问进度,午觉也没有睡所以今天预计的很多计划都处于停滞状态,像昨天规划的今天 ...
- api服务器开发语言,【API编写】介绍一个国内强大的API接口文档写作网站showdoc - 最好的编程语言 - 博客园...
这几天要写一个接口API文档,经理给我发过来一个,说要弄一个这样的接口文档,我一看,这可麻烦呀,有大纲有详细,我以为要用div+css去一个页面一个页面做呢,这工作量可不小,网站一搜索,竟然有可以直接 ...
- php怎么根据接口文档实现功能,CodeIgniter+swagger实现 PHP API接口文档自动生成功能...
一.安装swagger 1.首先需要有composer,没有的自行百度安装 2.下载swagger,打开网站https://packagist.org/packages/zircote/swagger ...
最新文章
- 中科院自动化所17篇CVPR 2022 论文新作速览!
- Docker 大势已去,Podman 万岁
- python 单元测试 工具_Django单元测试工具test client使用详解
- 如何在SAP Spartacus category 页面里拿到当前的category信息
- java实现表达式求值_如何编写一个高效的Java表达式求值程序
- ubuntu 虚拟机上的 django 服务,在外部Windows系统上无法访问
- CocosCreator发布web-desktop获取本地资源
- win10切换桌面_学废了Win10的这些骚操作,我不信你拽不起来
- 2011蓝桥杯--神秘的三位数
- 灰常实用的一键开关机电路,各位大佬进来mark一下?
- vue-ele-form的dialog取消默认按钮
- AR技术应用 の 如何做一个Pokemon GO丢出精灵球抓住皮卡丘吧!(2)
- XCTF---MISC---来自银河的信号
- 活体检测论文笔记2——Deep Spatial Gradient and Temporal Depth Learning for Face Anti-spoofing
- Polyhedral Compilation及ISL学习资料
- 苹果老板乔布斯在斯坦福大学的演讲
- [C语言]实现一个关机整蛊的小程序
- Android偏好设置的使用
- 怎样使自己有积极的心态
- oracle高水位线以及pctfree、pctused