Some API Formats and Conventions

Opinions Follow, your mileage may vary

REST - Formalized HTTP

Authorization

GET /gists HTTP/1.1
Host: api.github.com

HTTP/1.1 401 Authorization Required
Date: Sat, 30 July 2011 00:01:15 GMT
WWW-Authenticate: Basic realm="Secure Area"
Content-Type: text/html
Content-Length: 0

GET /gists HTTP/1.1
Host: api.github.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

REST - Formalized HTTP

Each URL represents a Resource

GET /gists
...

GET /issues
...

POST /repos/issackelly/Consuming-Web-APIs-with-Python-Talk/issues
...

REST - Formalized HTTP

Use your Verbs

POST /repos/issackelly/Consuming-Web-APIs-with-Python-Talk/issues
Host: api.github.com
Content-Type: application/json
Content-Length: 311

{...}

HTTP/1.1 201 Created
Location: https://api.github.com/repos/issackelly/Consuming-Web-APIs-with-Python-Talk/issues/1
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999

GET /repos/issackelly/Consuming-Web-APIs-with-Python-Talk/issues/1
...

REST - Formalized HTTP

Trust HTTP Codes

GET /repos/issackelly/Consuming-Web-APIs-with-Python-Talk/issues/1
...

HTTP/1.1 200 Found
...

GET /repos/issackelly/notreal
...

HTTP/1.1 404 Not Found

POST /repos/issackelly/Consuming-Web-APIs-with-Python-Talk/issues
...

HTTP/1.1 400 Bad Request
            

REST - Formalized HTTP

Now, onto the terminal, where the "with python part starts"

Breaking REST, and into the Unknown

Thank You

Questions?

• Email Me
• This Talk
• Kelly Creative Tech