JSON API and Function API
Blueprints are defined in JSON format, but the underlying implementation uses JavaScript functions to execute the steps. While JSON is the most convenient way of interacting with Blueprints, you can also use the underlying functions directly.
JSON is merely a wrapper around the functions. Whether you use the JSON steps or the exported functions, you'll have to provide the same parameters (except for the step name):
You can use Blueprints both with the web and the node.js versions of WordPress Playground.
The team is exploring ways to transition Blueprints from a TypeScript library to a PHP library. This would allow people to run Blueprints in any WordPress environments: Playground, a hosted site, or a local setup.
The proposed new specification is discussed on a separate GitHub repository, and you’re more than welcome to join (there or on the #meta-playground Slack channel) and help shape the next generation of Playground.
Differences between JSON and Function APIs
There are two main differences between the JSON and Function APIs:
- Blueprints handle the progress bar and error reporting for you. The function API requires you to handle these yourself.
- The function API requires importing the API client library while Blueprints may be just pasted into the URL fragment.
Check the Use the same structure for Blueprint JSON definitions and step handlers issue at wordpress-playground repo for more detailed info about this topic