Introduction to REST API

Transcript

1. Introduction to REST API Prasath Nadarajah
2. Whats is REST? • Representational State Transfer • Simpler and easy to implement. • Uniform interface / Decoupled architecture • Stateless • Cacheable • Client-server • Layered system
3. HTTP verbs • POST - create something • GET - get something • PUT - update something • DELETE - delete something • PATCH - partial update • HEAD - retrieve header info • OPTIONS - list available actions • TRACE - Echo back
4. HTTP status codes • 1xx - Informational • 2xx - Success • 3xx - Redirection • 4xx - Client error • 5xx - Server error
5. Why REST API in WordPress? • More flexibility • Decouple Front End and CMS • Multiple frontends • Faster applications and interactive experiences
6. State of REST API in WordPress • WordPress already had an XML-RPC based web service • First started as a Google Summer of Code project by Ryan McCue • Developed as a plugin now.. Currently in 2.0 beta 13 • Follow the updates and participate
7. Resources • https://github.com/WP-API/WP-API • http://v2.wp-api.org/reference/ • https://wordpress.org/plugins/rest-api/ • https://make.wordpress.org/core/tag/rest-api/ • http://v2.wp-api.org/extending/javascript-client/
8. List of REST API Endpoints • Post • Post revisions • Pages • Media • Post types • Post statuses • Categories • Tags • Users • Comments • Taxonomies
9. Examples • GET /wp/v2/posts • DELETE /wp/v2/posts/<id> • POST /wp/v2/comments
10. Authentication in REST API • Basic (Requires plugin) • Cookies • Oauth (Requires plugin)
11. Adding a new endpoint <?php add_action( 'rest_api_init', function () { register_rest_route( 'myplugin/v1', '/author/(?P<id>\d+)', array( 'methods' => 'GET', 'callback' => 'my_awesome_func', ) ); } );
12. GraphQL • A data query language • Developed by Facebook • Its a specification Task : Implementing a GraphQL server for WordPress
13. Questions?