Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update readme file

This commit is contained in:
Mike Jolley 2019-06-06 12:31:43 +01:00
parent 1aee7b5644
commit 60a5a8a0ff
1 changed files with 39 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -1,34 +1,54 @@
---
title: 'WooCommerce REST API'
---
WooCommerce REST API
===
This repository houses the WooCommerce REST API found in the core WooCommerce plugin.
This repository is home to the WooCommerce REST API package.
It can also be used as a standalone plugin (it still requires WooCommerce!), or can be pulled into other projects and feature plugins that need new API features that are not yet in the core release.
The stable version of this package is bundled with [WooCommerce core](https://github.com/woocommerce/woocommerce) releases, but it can also be used as a standalone plugin so bleeding-edge API features can be tested or used by other feature plugins.
Once stable, changes in woocommerce-rest-api are brought over to [WooCommerce core](https://github.com/woocommerce/woocommerce) when they are ready for release.
## Using this package
## Endpoint namespaces
This package is [hosted on Packagist](https://packagist.org/packages/woocommerce/woocommerce-rest-api) and can be included using composer.json:
* Current stable WC REST API version: **wc/v3** - **[Docs](https://woocommerce.github.io/woocommerce-rest-api-docs/)**
* WC Blocks REST API version (internal use only): **wc-blocks/v1**
* Older versions:
* **wc/v1** - **[Docs](https://woocommerce.github.io/woocommerce-rest-api-docs/wp-api-v1.html)**
* **wc/v2** - **[Docs](https://woocommerce.github.io/woocommerce-rest-api-docs/wp-api-v2.html)**
```json
"require": {
"woocommerce/woocommerce-rest-api": "1.0.0"
},
```
Since multiple versions of this package may be included at the same time, WooCommerce handles loading __only the latest version__ by using a special loader.
After including the package and installing dependencies, include the main `woocommerce-rest-api.php` file in your code:
```php
include 'vendor/woocommerce-rest-api/woocommerce-rest-api.php';
```
This will register the version of the package with WooCommerce and make it available after the `woocommerce_loaded` hook is fired.
## API documentation
- [Usage documentation for the REST API can be found here](https://github.com/woocommerce/woocommerce/wiki/Getting-started-with-the-REST-API).
- [Contribution documentation can be found here.](https://github.com/woocommerce/woocommerce/wiki/Contributing-to-the-WooCommerce-REST-API)
### Versions
| Namespace | Status | Docs |
| -------- | -------- | -------- |
| `wc/v4` | Development | [Link](https://woocommerce.github.io/woocommerce-rest-api-docs/) |
| `wc/v3` | Stable | [Link](https://woocommerce.github.io/woocommerce-rest-api-docs/) |
| `wc/v2` | Deprecated - October 2020 | [Link](https://woocommerce.github.io/woocommerce-rest-api-docs/wp-api-v2.html) |
| `wc/v1` | Deprecated - April 2019 | [Link](https://woocommerce.github.io/woocommerce-rest-api-docs/wp-api-v1.html) |
Note: API Versions are kept around for 2 years after being replaced, and may be removed in the next major version after that date passes.
## Contributing
Please read the [WooCommerce contributor guidelines](https://github.com/woocommerce/woocommerce/blob/master/.github/CONTRIBUTING.md) for more information how you can contribute.
Please read the [WooCommerce contributor guidelines](https://github.com/woocommerce/woocommerce/blob/master/.github/CONTRIBUTING.md) for more information how you can contribute to WooCommerce, and [the REST API contribution documentation here](https://github.com/woocommerce/woocommerce/wiki/Contributing-to-the-WooCommerce-REST-API).
Endpoints are located in the `includes/` directory. Endpoints currently inherit from the stable version of the endpoint. If you need to change the behavior of an endpoint, you can do so in these classes.
Within this package, namespaces and endpoint classes are located within the `src/RestAPI/` directory. If you need to change the behavior of an endpoint, you can do so in these classes.
phpunit tests for the API are located in the `tests/unit-tests/` folder and are also merged and shipped with WooCommerce core. You can use the same helpers/framework files that core uses, or introduce new ones.
Run tests using `phpunit` in the root of this folder. Code coverage reports can be ran with `phpunit --coverage-html /tmp/coverage`.
Run tests using `phpunit` in the root of the package. All pull-requests must pass unit tests in order to be accepted.
## Translation
For strings located in API endpoints, use `woocommerce` as your text-domain. These endpoints will at some point be merged back into WooCommerce Core.
For strings located in API endpoints, use `woocommerce` as your text-domain. These endpoints will be translated in the WooCommerce Core PO/MO files.