APIs: The good, the bad, the ugly

50 %
50 %
Information about APIs: The good, the bad, the ugly
Software

Published on April 26, 2014

Author: micheletitolo

Source: slideshare.net

Description

Apps consume a lot of web services these days. Sometimes, these new services can be fantastic, and other times not so much. Learning how to evaluate APIs and identify problem areas before jumping head first into development can save us frustration, time, and money. This session will walk through evaluating an API, best practices, and red flags, all from the standpoint of an iOS dev. No matter your experience level, you'll leave with the skills to effectively tackle your next API.

APIs: The good, the bad, the ugly @MicheleTitolo

What we’ll cover

Documentation

The Good

It exists

Bonus: it’s interactive

I/O Docs

The Bad

Docs aren’t updated

The Ugly

Documentation?

URLs

The Good

Consistency

/users/22445 /products/3156 /movies/127/times

The Bad

Inconsistency

/users/22445 /reviews/3156 /times/127 Not review or time id’s

The Ugly

“Send GET to /remove to delete”

Payloads

The Good

You have all the data you need

The Bad

Endpoint “id” field /products id /products/:id productID /cart product_id

Yes, this actually happened

Change

We expect certain things

...like image urls having http://

...like dates sent in the same format

We expect certain things to not change

The Ugly

JSON containing HTML

Unstable

Authentication

The Good

HTTP Basc Auth over SSL

...when SSL is secure

OAuth

The Bad

OAuth

The Ugly

Authorization

The Good

App requests permissions

The Bad

A single API key

The Ugly

Authorization?

goto fail;

Errors

The Good

Error codes

Error message in response

Human readable error message

The Bad

“There was an error”

The Ugly

Caching

The Good

Using one of the standards

Cache-Control

If-Modified-Since

etags

The Bad

Manually processing data

The Ugly

Caching

In Summary

Consistency

Conventions

Simple

Questions? @MicheleTitolo

• JSONSchema, RAML, API Blueprint, • HTTP 1.1 Spec: http://www.w3.org/Protocols/rfc2616/ rfc2616.html • Charles, Postman • http://runscope.com, also http://newrelic.com for backend analytics • Versioning: http://apiux.com/2013/05/14/api- versioning/ Q&A Resources

Add a comment

Related presentations

Speaker: Matt Stine Developing for the Cloud Track Marc Andressen has famou...

This presentation explains how to develop a Web API in Java using (JAX-RS or Restl...

1 App,

1 App,

November 10, 2014

How to bring innovation to your organization by streamlining the deployment proces...

Cisco Call-control solutions can handle voice, video and data

Nathan Sharp of Siemens Energy recently spoke at the SAP Project Management in Atl...

Related pages

APIs: the good, the bad, and the ugly · GitHub

APIs: the good, the bad, and the ugly. Michele Titolo @micheletitolo; Who's built, designed, and spec'd a lot of APIs; Talk will focus on web APIs, but ...
Read more

The Good, the Bad, and the Ugly of REST APIs - O'Reilly ...

I've never seen a perfect REST API. But I have seen some of the most horrible mistakes repeated over and over again by people building heavily consumed APIs.
Read more

[FutureTalk] APIs: The Good, the Bad, and the Ugly - YouTube

Michele Titolo, iOS app developer and CTO of Women Who Code, gives a New Relic FutureTalk in Portland on the importance of putting user ...
Read more

The Good, the Bad, and the Ugly of REST APIs

A new blog post by George Reese provides a wealth of recommendations on best practices and common pitfalls of REST APIs implementation.
Read more

APIs: the Good, the Bad and the Ugly - Swof Media

APIs: the Good, the Bad and the Ugly. Home | Development | APIs: the Good, the Bad and the Ugly
Read more

Education APIs: The Good, The Bad, and the Ugly (API Days ...

... The Bad, and the Ugly (API Days Paris 2013 ... technology as we know from Kranzberg’s Law is neither good nor bad nor neutral. APIs aren’t ...
Read more

Network APIs: the good, the bad, and the ugly

Today we feature a deep-dive guest post from Scott Atchley, HPC Systems Engineer in the Technology Integration Group at Oak Ridge National Laboratory.
Read more

DevChat.TV

APIs: The Good, The Bad, The Ugly - Ruby Remote Conf 2015. Published on: 11-03-2015. ... This session will walk through evaluating an API, best practices, ...
Read more

The Good, the Bad and the Ugly (1966) - Rotten Tomatoes

... this classic western isn't bad or good or ugly, just moderately interesting. ... API; Licensing; JOIN THE NEWSLETTER. Get the freshest ...
Read more