woocommerce / woocommerce-rest-api
WooCommerce 核心REST API。
Requires
- automattic/jetpack-autoloader: ^2.0.0
Requires (Dev)
- phpunit/phpunit: 6.5.14
- woocommerce/woocommerce-sniffs: 0.0.9
- dev-master
- 1.0.15
- 1.0.14
- 1.0.13
- 1.0.12
- 1.0.11
- 1.0.10-pl-2
- 1.0.10-pl-1
- 1.0.10
- 1.0.9
- 1.0.9-rc.2
- 1.0.9-rc1
- 1.0.8
- 1.0.7
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- dev-dependabot/npm_and_yarn/glob-parent-5.1.2
- dev-release/1.0
- dev-release/1.0.10-pl
- dev-vedanshu/temp
- dev-temp
- dev-performance/api-enhancements
- dev-fix/ada-v4-classmap
- dev-enhancement/products
- dev-improve/system-status-v4
This package is auto-updated.
Last update: 2021-06-10 23:52:56 UTC
README
注意:此插件现已合并到 WooCommerce 核心中,所有开放问题和PR最终将转移到 WooCommerce 核心仓库。请直接向核心仓库提交所有新问题和PR。
此仓库是 WooCommerce REST API 包的所在地。
此包的稳定版本包含在 WooCommerce 核心版本 中,但它也可以作为一个独立的插件使用,以便测试或由其他功能插件使用最新的API功能。我们不建议在生产环境中将此仓库作为独立的插件使用。
将此包用作插件
将代码检出到您的 wp-content/plugins
目录后,您需要在插件目录(wp-content/plugins/woocommerce-rest-api
)中运行 composer install
来安装依赖项并启用自动加载。如果不执行此步骤,激活插件只会显示一个管理通知。
API 文档
版本
命名空间 | 状态 | 文档 |
---|---|---|
wc/v4 |
开发中 | 链接 |
wc/v3 |
稳定版 | 链接 |
wc/v2 |
已弃用 - 2020年10月 | 链接 |
wc/v1 |
已弃用 - 2019年4月 | 链接 |
注意:API 版本在替换后保留2年,并在该日期过后下一个主要版本中可能被移除。
在其他项目中使用此包
此包托管在 Packagist 上,可以使用 composer.json 包含。
"require": { "woocommerce/woocommerce-rest-api": "1.0.0" },
由于可能同时包含此包的多个版本,它包含一个特殊的包版本自动加载器。此依赖项也在 Packagist 上。
"automattic/jetpack-autoloader": "^1"
使用此自动加载器需要在您的代码库中包含以下内容
$autoloader = __DIR__ . '/vendor/autoload_packages.php';
如果您选择使用自己的自动加载器,请注意您将无法确定正在运行的包版本,因为它可能使用 WooCommerce 核心版本或您的版本。命名空间将冲突。我们所有的功能插件和包都使用包自动加载器。
贡献
请阅读WooCommerce 贡献指南获取更多关于如何为 WooCommerce 做贡献的信息,以及此处 REST API 贡献文档。
在此包中,命名空间和端点类位于src/RestAPI/
目录下。如果您需要更改端点的行为,可以在这些类中进行更改。
在包的根目录下使用phpunit
运行测试。所有拉取请求都必须通过单元测试才能被接受。
翻译
对于位于 API 端点的字符串,使用woocommerce
作为您的文本域。这些端点将在 WooCommerce 核心PO/MO文件中翻译。