How to build an API your developers will love - Code.talks 2015, Hamburg by Michael Kuehne

Slide 1

Slide 1 text

How to build an API your developers will love? Michael Kuehne

Slide 2

Slide 2 text

Michael Kuehne Independent Software Engineer API Specialist

Slide 3

Slide 3 text

Why should you build an API your developers will love?

Slide 4

Slide 4 text

Your API is a Product

Slide 5

Slide 5 text

Create a Developer Experience User Scenarios & User Stories Personas

Slide 6

Slide 6 text

Don‘t forget these Guys

Slide 7

Slide 7 text

Create an overall Experience with DX Core

Slide 8

Slide 8 text

UX UX Honeycomb

Slide 9

Slide 9 text

Simple Functions and Calls Useful to me vs. Userful by Design

Slide 10

Slide 10 text

Create value for a business Service, Data, Audience, ...

Slide 11

Slide 11 text

Long-Term Mindset Consistency

Slide 12

Slide 12 text

RESTful Naming HAL for XML & JSON

Slide 13

Slide 13 text

V1 Versioning

Slide 14

Slide 14 text

Where% What% Who% Example% Path%segment% Data% Twilio% /2015;09;01/...% Path%segment% Number% TwiAer% /1/...% Path%segment% ‘v‘%+%Number% LinkedIn% /v1/...% Path%segment% ‘v‘%+%Number% Yelp% .../v1/...% Query%string% Number% Google% ?v=2% Custom%HTTP%Header% Number% Google% GData;Version:%2% HTTP%Accept%Header% Number% GitHub% ApplicaUon/vnd.github[.version]% Path%segment% Number% Michael% Kuehne% /v2;3/...% Versioning

Slide 15

Slide 15 text

Error Messages

Slide 16

Slide 16 text

Publish your Tests Provide Stubs

Slide 17

Slide 17 text

SDKs Dev Dashboard Sandbox

Slide 18

Slide 18 text

No content

Slide 19

Slide 19 text

Documentation Communication

Slide 20

Slide 20 text

HATEOAS Extend Responses

Slide 21

Slide 21 text

Reliable APIs Legal Part

Slide 22

Slide 22 text

And what does Apple?

Slide 23

Slide 23 text

„An API is a Journey Not a destination“ John Musser

Slide 24

Slide 24 text

Thank you and start creating API your Developers will love! Michael Kuehne [email protected] @michikuehne

Slide 25

Slide 25 text

Credits •  Stormtropper with Heart https://flic.kr/p/7CMCXh •  Apple Stormtropper https://flic.kr/p/8pxp41 •  Logo Quad Racer https://flic.kr/p/dXan4x •  Business man https://flic.kr/p/9ahi5b •  See in the Mountains https://flic.kr/p/bDg5Ms •  Leathermen https://flic.kr/p/7BMTj9 •  Traffic Sign https://flic.kr/p/4uZDqS •  Hello my name is https://flic.kr/p/7NudQf •  LED https://flic.kr/p/eQy2Um •  Toolbox https://flic.kr/p/bkSP2c •  Chocolate https://flic.kr/p/eMKxsK •  Boy Scouts https://flic.kr/p/cdxFkW •  Wheel chair https://flic.kr/p/9g1LDE •  Church https://flic.kr/p/opTHCA •  Kayak https://flic.kr/p/bSaLKB