Slide 1

Slide 1 text

Introduction to the REST API Ryan McCue
 Senior Engineer at Human Made

Slide 2

Slide 2 text

What is the API?

Slide 3

Slide 3 text

What is the API?

Slide 4

Slide 4 text

Why is the API? A history of the API

Slide 5

Slide 5 text

Existing WordPress APIs

Slide 6

Slide 6 text

XML-RPC Existing APIs & friends Most powerful:

Slide 7

Slide 7 text

JSON-RPC Existing APIs

Slide 8

Slide 8 text

Existing APIs

Slide 9

Slide 9 text

JSON-RPC Existing APIs

Slide 10

Slide 10 text

admin-ajax Existing APIs & friends Most developer friendly:

Slide 11

Slide 11 text

RSS Existing APIs & friends Most used:

Slide 12

Slide 12 text

RSS.js Existing APIs

Slide 13

Slide 13 text

Existing APIs

Slide 14

Slide 14 text

RSS.js Existing APIs

Slide 15

Slide 15 text

The World Wide Web

Slide 16

Slide 16 text

World Wide Web

Slide 17

Slide 17 text

No content

Slide 18

Slide 18 text

No content

Slide 19

Slide 19 text

No content

Slide 20

Slide 20 text

No content

Slide 21

Slide 21 text

World Wide Web

Slide 22

Slide 22 text

No content

Slide 23

Slide 23 text

No content

Slide 24

Slide 24 text

World Wide Web

Slide 25

Slide 25 text

No content

Slide 26

Slide 26 text

No content

Slide 27

Slide 27 text

WordPress.com API

Slide 28

Slide 28 text

No content

Slide 29

Slide 29 text

.com API …REST?

Slide 30

Slide 30 text

No content

Slide 31

Slide 31 text

.com API WordPress.com specifics

Slide 32

Slide 32 text

No content

Slide 33

Slide 33 text

.com API Inspiration

Slide 34

Slide 34 text

.com API Unification

Slide 35

Slide 35 text

Birth of a Plugin

Slide 36

Slide 36 text

No content

Slide 37

Slide 37 text

JSON

Slide 38

Slide 38 text

JSON Language Support

Slide 39

Slide 39 text

No content

Slide 40

Slide 40 text

No content

Slide 41

Slide 41 text

No content

Slide 42

Slide 42 text

JSON Not XML

Slide 43

Slide 43 text

JSON JSONP

Slide 44

Slide 44 text

JSON

Slide 45

Slide 45 text

No content

Slide 46

Slide 46 text

JSON

Slide 47

Slide 47 text

No content

Slide 48

Slide 48 text

JSON

Slide 49

Slide 49 text

JSON /**/callback({…

Slide 50

Slide 50 text

REST

Slide 51

Slide 51 text

REST Browser Support

Slide 52

Slide 52 text

REST RPC

Slide 53

Slide 53 text

REST Challenges

Slide 54

Slide 54 text

Response Format

Slide 55

Slide 55 text

Responses Breaking from Core Names

Slide 56

Slide 56 text

Responses Posts ID => id post_content => content
 post_name => slug

Slide 57

Slide 57 text

Responses Comments comment_ID => id comment_content => content
 post_name => slug

Slide 58

Slide 58 text

Responses Terms term_id => id
 name => name slug => slug

Slide 59

Slide 59 text

Responses Users ID => id
 display_name => name user_nicename => slug

Slide 60

Slide 60 text

Responses Enveloping

Slide 61

Slide 61 text

No content

Slide 62

Slide 62 text

Responses $ http demo.wp-api.org/wp-json/v2/wp?_envelope HTTP/1.1 200 OK { "body": { "name": "WP API Demo", "description": "Just another WordPress site”, "_links": { ... }, "headers": { "Allow": "GET" }, "status": 200 }

Slide 63

Slide 63 text

Responses HAL

Slide 64

Slide 64 text

No content

Slide 65

Slide 65 text

Responses JSON Schema

Slide 66

Slide 66 text

Infrastructure

Slide 67

Slide 67 text

Infrastructure Request & Response

Slide 68

Slide 68 text

Infrastructure Separation of Concerns

Slide 69

Slide 69 text

Infrastructure REST Server vs Rewrites

Slide 70

Slide 70 text

Problems

Slide 71

Slide 71 text

Problems It’s New

Slide 72

Slide 72 text

Problems Meta

Slide 73

Slide 73 text

Problems Authentication

Slide 74

Slide 74 text

Bad / Good?

Slide 75

Slide 75 text

Help Us!

Slide 76

Slide 76 text

Thanks. speakerdeck.com/rmccue