renemanqueros

<p>Allows developers to create REST-ish API’s that have access to all of WordPress and its plug-ins objects.</p>
<h3>Usage</h3>
<p>Install the plug-in as any other plug-in.<br />
Project is divided in two sets of files:</p>
<pre><code>* index.php - This is where you register routes and/or middleware.
* routes/ - This is where you place your routes.
</code></pre>
<h3>Middleware</h3>
<p>Middlewares are functions that will be executed on every call to the API, generally used to validate parameters or<br />
transform requests before they reach routes, code for middleware is structured like this:</p>
<pre><code>app::middleware(function () {
    doSomething();
});
</code></pre>
<ul>
<li>Middlewares run for every Verb and do not automatically assign $_POST or $_GET to any variable</li>
</ul>
<h3>Routes</h3>
<p>A route is where you would link a request to a function depending on its HTTP Verb.<br />
The routing engine will prepend /api/ to all calls and will append a trailing slash to all requests.<br />
A GET request would be matched like this:</p>
<pre><code>app::get('/testget', function($req){
   return $req;
});
</code></pre>
<p>In which:</p>
<pre><code>* app::get - This will match up a GET request.
* '/testget' - the path the routing engine will look for.
* function(){ } ... - the function to execute when the route is matched.
* $req - parameters sent to the verb.
</code></pre>
<p>To make a call to this route, the full path would be:</p>
<pre><code>http://www.mysite.com/api/testget/
</code></pre>
<ul>
<li>The trailing slash is always required.</li>
<li>Parameters for all routes will be sent as the first parameter to the callback.</li>
</ul>
<p>A route should be registered on the index file by placing a call to app::routes with the filename of the route (without the extension) as a parameter:</p>
<pre><code>app::routes('test');
</code></pre>
<ul>
<li>All routes output their return value as a JSON encoded response.</li>
</ul>
<h3>Samples for all verbs</h3>
<ul>
<li>
<p>GET:</p>
<p>app::get(‘/testget’, function($req){<br />
   return $req;<br />
});</p>
</li>
<li>
<p>POST:</p>
<p>app::post(‘/testpost’, function($req){<br />
    return $req;<br />
});</p>
</li>
<li>
<p>DELETE:</p>
<p>app::delete(‘/testdelete’, function($req){<br />
    return $req;<br />
});</p>
</li>
<li>
<p>PUT:</p>
<p>app::put(‘/testput’, function($req){<br />
    return $req;<br />
});</p>
</li>
</ul>
<h3>Nested routes</h3>
<p>Routes can be nested like this:</p>
<pre><code>app::delete('/admin/machines', function($req){
    return $req;
});
</code></pre>
<p>Which could be called by issuing a DELETE to:</p>
<pre><code>http://www.mysite.com/api/admin/machines/<h3>Route and middleware registration</h3>
Code for the routes should be placed on a file inside the "routes" folder and then "registered" on the index.php file like this:
</code></pre>
<p>function gp_registerapimethods()<br />
{<br />
    app::middleware(function () {</p>
<pre><code>});

app::routes('test');
</code></pre>
<p>}</p>
<p>Only one instance of the gp_registerapimethods should exist on the index.php file.<br />
Middleware and Routes can have as many instances as needed.<br />
All routes inside the routes folder can be registered by doing this call instead of the individual route registration:</p>
<pre><code>  app::routes('*');
  <h3>Sample for everything</h3> The index.php file has the "test" route registered, and that test.php route a call for each verb which you could use as a starting point for your own services.
</code></pre>


GP routing – WP compatible REST API

Allows developers to create REST-ish API's that have access to all of Wordpress and its plug-ins objects.

Acato

Richard Korthuis

yoeridekker

<p>Are you facing speed issues, using the WordPress REST API? This plugin will allow WordPress to cache the responses of the REST API, making it much faster.</p>
<p>This plugin offers:</p>
<ul>
<li>Caching of all default WordPress REST API <code>GET</code>-endpoints.</li>
<li>Caching of (custom) post type endpoints.</li>
<li>Caching of (custom) taxonomy endpoints.</li>
<li>Automated flushing of caches if (some of) its contents are edited.</li>
<li>Manual flushing of all caches.</li>
<li>Manual flushing of specific caches.</li>
<li>A counter how many times a cache has been retrieved.</li>
<li>Specifying after what time the cache should be timed out.</li>
<li>Registering custom endpoints for caching.</li>
<li>Automatic cache regeneration.</li>
</ul>
<p><strong>WP REST Cache Pro</strong><br />
For more advanced features, check out our <a href="https://plugins.acato.nl/" rel="nofollow ugc">WP REST Cache Pro</a> plugin:</p>
<ul>
<li>Configure custom endpoints for caching through the wp-admin interface.</li>
<li>Configure relationships within endpoints.</li>
<li>No coding required.</li>
</ul>
<h3>Installation from within WordPress</h3>
<ol>
<li>Visit ‘Plugins > Add New’ (or ‘My Sites > Network Admin > Plugins > Add New’ if you are on a multisite installation).</li>
<li>Search for ‘WP REST Cache’.</li>
<li>Activate the WP REST Cache plugin through the ‘Plugins’ menu in WordPress.</li>
<li>Go to “after activation” below.</li>
</ol>
<h3>Installation manually</h3>
<ol>
<li>Upload the <code>wp-rest-cache</code> folder to the <code>/wp-content/plugins/</code> directory.</li>
<li>Activate the WP REST Cache plugin through the ‘Plugins’ menu in WordPress.</li>
<li>Go to “after activation” below.</li>
</ol>
<h3>After activation</h3>
<ol>
<li>Visit ‘Plugins > Must-Use’ (or ‘My Sites > Network Admin > Plugins > Must-Use’ if you are on a multisite installation).</li>
<li>Check if the ‘WP REST Cache – Must-Use Plugin’ is there, if not copy the file <code>wp-rest-cache.php</code> from the <code>/sources</code> folder of the WP REST Cache Plugin to the folder <code>/wp-content/mu-plugins/</code>.</li>
</ol>
<p><strong>Optionally:</strong><br />
The default timeout for caches generated by the WP REST Cache plugin is set to 1 year. If you want to change this:</p>
<ol>
<li>Visit ‘Settings > WP REST Cache’.</li>
<li>Change the Cache timeout.</li>
</ol>


WP REST Cache

I have been using this plugin on a few projects and it has been extremely useful, but recently I came across a few more complicated scenarios I needed to cater for and the plugin author has been extremely helpful in discussing the extra config that I needed. Definitely recommend. 

Very good plugin, very good support

slow api requests now respond in an instant. running this tool on multiple sites and it works almost by simply installing it. noice!


Great plugin! I use it for a headless WordPress instance with Nuxt 3, and it works perfectly fine.



The only thing I needed to change was the API endpoint since I created a custom endpoint to the route. But the FAQ cleared this up quickly and it works flawlessly. As a small suggestion I'd propose to add this option to the plugin's settings page for easier access.


Works well with headless WordPress and Nuxt 3


Nice one! Decreased response time by almost 60%.


Does the job

Enable caching of the WordPress REST API and auto-flush caches upon wp-admin editing.

GP routing – WP compatible REST API vs WP REST Cache