Tweet
Tweet

Slide 1

Slide 1 text

Emmanuel Paraskakis @manp

Slide 2

Slide 2 text

Apiary.io

Slide 3

Slide 3 text

Collaborate on API Design 174,209 APIs 1.8M+ Consumers 131,697 Designers

Slide 4

Slide 4 text

Managing Risk in API Projects What I learned from building APIs in Insurance the past 7 years

Slide 5

Slide 5 text

Incredible demand for APIs Mobile Apps Data Collection Automation Regulation Integrations Partnerships

Slide 6

Slide 6 text

HBR: Corporate Alliances Matter Less Thanks to APIs https://hbr.org/2015/06/corporate-alliances-matter-less-thanks-to-apis “APIs, on the other hand, turn the burden of finding partners willing to share risks and offer complementary resources on its head.
 With APIs, companies pivot from finding partners to letting partners find them.”

Slide 7

Slide 7 text

What Could Possibly Go Wrong?

Slide 8

Slide 8 text

No content

Slide 9

Slide 9 text

No content

Slide 10

Slide 10 text

(Project Execution Risk)++ • API Projects are like any IT project but more so • API Consumers are external to organization or team so the risk of getting it wrong multiplies

Slide 11

Slide 11 text

No content

Slide 12

Slide 12 text

Things I’ve Seen… • Project took too long • Project cost too much

Slide 13

Slide 13 text

…Things I’ve Seen… • Didn't meet consumer needs • API Too difficult to understand • API docs were not accurate • Introduced security vulnerabilities

Slide 14

Slide 14 text

…Things I’ve Seen • Caused failed partnerships:
 Lined up partners but API wasn't what they expected • Contributed to missed market opportunities

Slide 15

Slide 15 text

No content

Slide 16

Slide 16 text

Process… • Treat the API as a Product
 (not a byproduct) • Get stakeholders involved:
 Design, Prototype, Iterate

Slide 17

Slide 17 text

…Process… • Manage lifecycle/change • Move fast but don't break things • Test/Validate to ensure Quality • TDD

Slide 18

Slide 18 text

…Process • Design first • Style Guide • Consistency

Slide 19

Slide 19 text

4 stages of API design API as a by-product of building apps API documentation generated from code Design-first API Development API Development Consistency

Slide 20

Slide 20 text

API as a by-product API as a by-product of building apps API documentation generated from code Design-first API Development API Development Consistency

Slide 21

Slide 21 text

API documentation generated from code API documentation generated from code Design-first API Development API Development Consistency API as a by-product of building apps

Slide 22

Slide 22 text

Design-first API Development Design-first API Development API Development Consistency API as a by-product of building apps API documentation generated from code

Slide 23

Slide 23 text

API Development Consistency API Development Consistency API as a by-product of building apps API documentation generated from code Design-first API Development

Slide 24

Slide 24 text

Only Tooling platform allows you to rapidly iterate/collaborate - It’s all we do! Apiary.io

Slide 25

Slide 25 text

Human readable/writable
 Machine friendly API Blueprint

Slide 26

Slide 26 text

FORMAT: 1A # Message of the Day API A simple [MOTD](http://en.wikipedia.org/wiki/motd) API. # Message [/messages/{id}] This resource represents one particular message identified by its *id*. ## Retrieve Message [GET] Retrieve a message by its *id*. + Response 200 (text/plain) Hello World! ## Delete Message [DELETE] Delete a message. **Warning:** This action **permanently** removes the message from the database. 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

Slide 27

Slide 27 text

Tools… • SaaS: no setup - sign up and go • Editor/Documentation/Mock Server/Traffic Inspector • Collaboration and rapid iteration (no need to build)

Slide 28

Slide 28 text

Backend Client

Slide 29

Slide 29 text

Backend Client

Slide 30

Slide 30 text

…Tools… • Testing/Dredd: TDD or CI • Ensure what you code meets specs • Ensure it continues to meet spec as you change • Tests created automatically, you don't have to write them • Test your API docs- In continuous integration!

Slide 31

Slide 31 text

Testing

Slide 32

Slide 32 text

…Tools • GitHub integration, the way you work: Manage change • Encoded Style Guide, across teams, consistency, oversight • Make changes but keep consistency (no need to read long style doc)

Slide 33

Slide 33 text

API Lifecycle Design Prototype Implementation Delivery Feedback Collaborative Editor Style Guide Approval Process Auto-generated Mock Quick Feedback Loop Documentation Code Samples Client Code Framework Integration TDD Server Code SDKs Support Style Assertions Auto-configured Clients

Slide 34

Slide 34 text

Risk Mitigation • Need to meet incredible demand • Fast cycles • Happy users/partners • Able to change, think GitHub • Seize Market opportunities
 (in the face of rapid change)

Slide 35

Slide 35 text

What You Can Do: 1. Try Apiary Out for Free:
 https://apiary.io 2. Talk to me:
 [email protected]
 (what problems are you coming across?) 3. Get Swag:
 This room!

Slide 36

Slide 36 text

Thanks! Image Credits: Harvard Business Review Home Box Office Inc. Trendhunter Marketing Apiary.io