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.

svrooij

<p>Since wordpress version 4.9.? wordpress includes the functionality provided by this plugin in the core of wordpress.</p>
<p>Checkout https://developer.wordpress.org/rest-api/using-the-rest-api/global-parameters/#_fields for functionality included in the wordpress core,<br />
they made it even better by filtering the amount of data pulled from the database.</p>
<p>This plugin will no longer be maintained since it has been superseded by the core functionality.</p>
<p>The <a href="https://wordpress.org/plugins/rest-api/" rel="ugc">wp-rest-api-v2</a> returns a lot of properties.<br />
It could be very useful (or mobile-data-friendly) to only return the properties needed by the application.</p>
<p>If you only want titles and links of some articles it doesn’t make sense to return the content or the excerpt.</p>
<p>This isn’t limited to posts, it also works on custom posttypes, categories, pages, terms, taxonomies and comments.</p>
<p>Instead of returning:</p>
<pre><code>{
  "id": 2138,
  "date": "2015-10-25T15:31:03",
  "guid": {
    "rendered": "http://worldofict.nl/?p=2138"
  },
  "modified": "2015-10-25T15:31:03",
  "modified_gmt": "2015-10-25T14:31:03",
  "slug": "rechtenvrije-fotos",
  "type": "post",
  "link": "http://worldofict.nl/tip/2138-rechtenvrije-fotos/",
  "title": {
    "rendered": "Rechtenvrije foto’s"
  },
  "content": {
    "rendered": ".. A lot of content .. "
  },
  "excerpt": {
    "rendered": " .. A lot of content ..."
  },
  "author": 2,
  "featured_image": 2139,
  "comment_status": "open",
  "ping_status": "open",
  "sticky": false,
  "format": "standard",
  //.. even more tags ....
}
</code></pre>
<p>It can return (with <code>fields=id,title.rendered,link</code> as GET parameter)</p>
<pre><code>{
  "id": 2138,
  "link": "http://worldofict.nl/tip/2138-rechtenvrije-fotos/",
  "title": {
    "rendered": "Rechtenvrije foto’s"
  }
}
</code></pre>
<h4>Notes</h4>
<ol>
<li>If you specify fields so it wouldn’t return data the default response is send back to the client.</li>
<li>(for developers) something wrong with this plugin? <a href="https://github.com/svrooij/rest-api-filter-fields/" rel="nofollow ugc">Github</a></li>
<li>If you liked the plugin <a href="https://github.com/sponsors/svrooij" rel="nofollow ugc">consider sponsoring me</a></li>
</ol>


REST API – Filter Fields

This is hands-down the best REST API extension available.

Best REST API plugin

Filter the properties returned by the Wordpress rest api V2 (only needed until wordpress 4.9)

GP routing – WP compatible REST API vs REST API – Filter Fields