jeffstieler / rest-console-embed
WPCOM Rest Console的短代码嵌入
0.1.0
2015-05-04 23:40 UTC
Requires
- jeffstieler/rest-api-console2: dev-master
This package is not auto-updated.
Last update: 2024-09-28 17:49:02 UTC
README
WordPress短代码插件,提供可嵌入的控制台,用于在内容中探索REST API。
基于Automattic的WordPress.com控制台。
使用短代码
[rest-console api_root="http://path/to/api" auth="none" width="100%" height="500px"]
api_root
- 目标API的根URL。
auth
- "none", "oauth", 或 "proxy"。使用除"none"之外的其他值留给读者自行练习。 ;)
width
- 包含div的宽度,默认为
100%
。
- 包含div的宽度,默认为
height
- 包含div的高度,默认为
500px
。
- 包含div的高度,默认为
API兼容性
为了使控制台正常工作,目标API需要
- 响应当前版本请求,指定在URL中(例如
/api/v1/endpoint
) - 提供一个
/versions
端点,以提供有关API不同版本的元数据 - 提供一个
/help
端点,以提供有关API端点的元数据- 见
https://public-api.wordpress.com/rest/v1.1/help
(请确保使用带有Accept: application/json
头的请求)
- 见