woocommerce/woocommerce-rest-api

此包已被弃用且不再维护。未建议替代包。

WooCommerce 核心REST API。

安装次数: 131,672

依赖项: 0

建议者: 0

安全: 0

星标: 44

关注者: 16

分支: 35

开放问题: 18

类型:wordpress-plugin

1.0.15 2020-08-17 14:28 UTC

README

注意:此插件现已合并到 WooCommerce 核心中,所有开放问题和PR最终将转移到 WooCommerce 核心仓库。请直接向核心仓库提交所有新问题和PR。

license Latest Stable Version Build Status Scrutinizer Code Quality

此仓库是 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文件中翻译。