Agile API development with apiary.io

Slide 1

Slide 1 text

Bee at Apiary Lukas Linhart AGILE API DEVELOPMENT WITH APIARY.IO

Slide 2

Slide 2 text

GitHub for APIs apiary.io

Slide 3

Slide 3 text

WHY WE DO THINGS • documentation and tooling, not architecture • man-years of API infrastructure work • companies & teams re-inventing the wheel

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

API DESIGN

Slide 6

Slide 6 text

No content

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

No content

Slide 9

Slide 9 text

No content

Slide 10

Slide 10 text

No content

Slide 11

Slide 11 text

No content

Slide 12

Slide 12 text

API DESIGN REIMAGINED

Slide 13

Slide 13 text

No content

Slide 14

Slide 14 text

HOST: http://api.twitter.com/ --- Twitter API 3.0 --- --- Welcome to our API. Comments support Markdown syntax --- -- Retrieve Tweets -- GET /tweets > Accept: application/json < 200 < Content-Type: application/json { "items": [ { "url": "/feed", "range":"2ZY48XPZ", "quantity": 1, "name": "New socks", "price": 1.25 } ] } API BLUEPRINT

Slide 15

Slide 15 text

MOCK SERVER

Slide 16

Slide 16 text

No content

Slide 17

Slide 17 text

No content

Slide 18

Slide 18 text

apiary.io Mock > Use > Implement

Slide 19

Slide 19 text

DOCUMENTATION

Slide 20

Slide 20 text

#2: DOCUMENTATION • how do I make an HTTP call? • try to follow documentation but API behaves differently • is it invalid? is it outdated? am I doing it wrong?

Slide 21

Slide 21 text

DOCUMENTATION REIMAGINED

Slide 22

Slide 22 text

DOCUMENTATION • includes runnable code examples (NOT API console) • is backed up by automated tests (never out of date)

Slide 23

Slide 23 text

No content

Slide 24

Slide 24 text

SUPPORT

Slide 25

Slide 25 text

#3: SUPPORT • my API calls are failing, no idea why • contacting customer support (that caters to shoe customers) • bumping my head against ﬁrst-tier support for days until I get connected to developers • by that time, debug information is lost, logs are rotated, new product version is deployed…

Slide 26

Slide 26 text

SUPPORT REIMAGINED

Slide 27

Slide 27 text

SUPPORT • includes self-service debugger • API support requests routed directly to devs with debugging information included

Slide 28

Slide 28 text

No content

Slide 29

Slide 29 text

apiary.io Mock > Use > Implement Documentation Automated Testing

Slide 30

Slide 30 text

http://github.com/apiaryio http://support.apiary.io/ COME HELP US

Slide 31

Slide 31 text

E-MAIL [email protected] TWITTER @apiaryio Q&A

Slide 32

Slide 32 text

CREDITS This presentation is shamelessly reused http://www.slideshare.net/jakub.nesetril/avoiding-api-waterfalls All creation credits go to Jakub ;) http://www.flickr.com/photos/ironrodart/4308675209/sizes/o/ http://www.flickr.com/photos/schlosi/6153707178/sizes/l/ http://www.flickr.com/photos/72153088@N08/6510934443/sizes/l/ http://www.flickr.com/photos/psd/3470234703/sizes/l/ http://www.flickr.com/photos/code_martial/2501920341/sizes/l/ http://www.flickr.com/photos/weesen/3589267112/sizes/l/ http://www.flickr.com/photos/weesen/3588454913/sizes/l/ http://www.flickr.com/photos/weesen/3589258380/sizes/l/ http://www.flickr.com/photos/polishsausagequeen/2178265710/ http://www.flickr.com/photos/stupidmommy/2649444581/sizes/z/