43 lines
No EOL
2.1 KiB
Markdown
43 lines
No EOL
2.1 KiB
Markdown
# 远程结构化数据验证
|
|
|
|
## 安装
|
|
|
|
```php
|
|
composer require woocommerce/remote-specs-validation
|
|
```
|
|
|
|
## 可用结构化数据
|
|
|
|
| 文件名 | 端点 | 捆绑包 |
|
|
| ------------------------------- | ------------------------------------------------------------------------------------------------------ | ---------------------------- |
|
|
| remote-inbox-notification.json | <https://woocommerce.com/wp-json/wccom/inbox-notifications/2.0/notifications.json> | remote-inbox-notification |
|
|
| payment-gateway-suggestions.json | <https://woocommerce.com/wp-json/wccom/payment-gateway-suggestions/2.0/suggestions.json> | payment-gateway-suggestions |
|
|
| obw-free-extensions.json | <https://woocommerce.com/wp-json/wccom/obw-free-extensions/4.0/extensions.json> | obw-free-extensions |
|
|
| wc-pay-promotions.json | <https://woocommerce.com/wp-json/wccom/payment-gateway-suggestions/2.0/payment-method/promotions.json> | wc-pay-promotions |
|
|
| shipping-partner-suggestions.json | <https://woocommerce.com/wp-json/wccom/shipping-partner-suggestions/2.0/suggestions.json> | shipping-partner-suggestions |
|
|
|
|
## 使用结构化数据
|
|
|
|
如果您是第一次使用 JSON 结构化数据，我们强烈建议先阅读 <https://json-schema.org/learn/getting-started-step-by-step>。
|
|
|
|
1. 从 `schemas` 目录打开一个结构化数据文件。
|
|
2. 进行更改。
|
|
3. 运行 `./bin/build schemas/:name-of-schema-file`
|
|
4. 捆绑的结构化数据文件将保存在 `bundles` 目录中。
|
|
|
|
## 验证示例
|
|
|
|
```php
|
|
use Automattic\WooCommerce\Tests\RemoteSpecsValidation\RemoteSpecValidator;
|
|
$validator = RemoteSpecValidator::create_from_bundle( 'remote-inbox-notification' );
|
|
|
|
$spec = json_decode( file_get_contents(":your-remote-inbox-noficiation-json") );
|
|
|
|
$result = $validator->validate( $spec );
|
|
|
|
if ( !$result->is_valid() ) {
|
|
var_dump( $result->get_errors() );
|
|
} else {
|
|
var_dump('everything looks good!');
|
|
}
|
|
``` |
