O3 CLI Services
In its current version, O3 CLI Services exposes two WordPress REST API endpoints
to empower developers and QA engineers to query URL paths of WordPress posts by
post types, category types, and menus.
Usage
Use the /wp-json/o3-cli-api/url-sources API endpoint to get a list of sources of
URL paths, and use the /wp-json/o3-cli-api/urls API to get a list of URL paths
of posts in the system, using your sources as URL query parameter filters.
Source filters for /wp-json/o3-cli-api/urls:
– post_types
– Include a comma-separated list of post type machine names.
– categories
– Include a comma-separated list of category slugs.
– menus
– Include a comma-separated list of menu slugs.
– limit
– Include an integer limit to control the maximum number of URL paths to
return for each machine name in any source.
An example request:
GET http://example.com/wp-json/o3-cli-api/urls?post_types=post,product&categories=food,travel&menus=main-navigation,footer-menu&limit=50
The above example requests the URL paths of posts of post types with the machine
names of ‘post’ and ‘product’, having categories with ‘food’ and ‘travel’ slugs,
as well as items in menus with ‘main-navigation’ and ‘footer-menu’ slugs. As
with any WordPress REST API endpoints, the above request returns a JSON array.
The O3 CLI automatically generates requests like the above, and it empowers
developers and QA engineers to dynamically generate visual regression tests,
among other needs. See the documentation at
https://www.npmjs.com/package/o3-cli.
Download & install the zip archive
The plugin package installer can be downloaded from the WP2E project tab called “code”.
1 – Select the version to download if this option is available otherwise the “latest” version of the main plugin will be used.
2 – After downloading the zip archive install the plugin package installer in you local environment and activate the script from the plugin list.
3 – Under the section “Plugins” of the admin dashboard you should see a new “Dependencies & Licenses” link. Follow the instructions from this panel to finalize the installation of the missing dependencies.
-
- Give a name to your project
-
- Download the Installer Package
-
- Install & activate the plugin locally
-
- Install the suggested dependencies
Tips: Use the WP2E panel to add/suggest new dependencies to the local installation. Press F5 in the list of dependencies if the changes are not displayed right away.