Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Building API Products

Building API Products

Samuel James

October 18, 2021
Tweet

More Decks by Samuel James

Other Decks in Technology

Transcript

  1. Building API Products
    1
    @samueljabiodun

    View full-size slide

  2. James Samuel
    ▪ ~8 years of experience making
    software run
    ▪ Tech Lead @Tier Mobility
    ▪ Technical Content Creator
    ▪ Creator of HubOfML Newsletter
    ▪ AWS Community Builder
    2
    @samueljabiodun
    @abiodunjames

    View full-size slide

  3. API is eating the world

    View full-size slide

  4. API has continued to gather popularity,
    grew by 100% in 2020
    Postman: State of the API Report
    5

    View full-size slide

  5. ▪ Offers APIs to open up services e.g Twitter, Facebook,
    Salesforce, etc
    ▪ API-first companies e.g Stripe, Contentful, Twilio, Algolia
    etc
    6

    View full-size slide


  6. Certain API products struggle to attract users.

    Hard to consume and integrates with some APIs.

    Some APIs don't live up to expectations.
    7

    View full-size slide

  7. 8
    Postman Report 2020: Obstacles to consuming APIs

    View full-size slide

  8. How do you create APIs developers
    love to use?
    9

    View full-size slide

  9. Good APIs are:
    ❏ Easy Learn
    ❏ Easy to use
    ❏ Hard not-easy to misuse
    ❏ Easy to read and maintain clients that use them
    ❏ Easy to evolve
    10

    View full-size slide

  10. Good API products make life easy
    11

    View full-size slide

  11. How do you make life easy?

    View full-size slide

  12. Understand the
    “Why” and “How”
    13

    View full-size slide

  13. ▪ Why do you want to build an API product?
    ▪ What problem will it solve?
    ▪ How will it help me achieve my goals?
    14

    View full-size slide

  14. Example Goal: Drive usage and monetize internal
    services
    15

    View full-size slide

  15. The goal isn't always obvious
    …Ask
    16

    View full-size slide

  16. Design Matters
    17

    View full-size slide

  17. “how quickly developers can get up to
    speed and start enjoying success using
    your API”
    18

    View full-size slide

  18. ➔ Vocabularies: Are your words, terms easy to understand for your users?
    ➔ Styles: What protocols are you supporting, Rest or GraphQL?
    ➔ Naturalness & Consistency:
    ◆ Do your users have to change their usual ways of solving their problems
    significantly?
    ◆ Did you follow established standards and conventions?
    ◆ What level of familiarity will you provide? Are you APIs similar to what your
    users may have used in the past?

    View full-size slide

  19. “Great API products are designed with
    rigorous customer focus, a deep
    understanding of the customers, their
    needs and desires”
    20

    View full-size slide

  20. How to approach API Design

    Identify your users & the activities they want to get done.

    Break down the activities they want to get down.

    Create APIs prototypes and validate with a use-case.

    Build clients that use the prototypes.

    Validate & re-iterate.
    21

    View full-size slide

  21. API Design is a
    continuous process
    22

    View full-size slide

  22. You won't get the first version of your APIs
    right. Some lessons can't be learned
    through customer interviews only.
    23

    View full-size slide

  23. Affordance is that property of an object
    which shows users the actions they can
    take.

    View full-size slide

  24. Get Good at
    Documentation
    27

    View full-size slide

  25. What's one of the first things you look at
    when exploring or evaluating a third party
    APIs?

    View full-size slide


  26. Evaluation

    Integration

    Debugging

    View full-size slide

  27. Integration/Getting Started

    View full-size slide

  28. Troubleshooting

    View full-size slide

  29. If you’re providing only one type of
    documentation, you’re undeserving your
    users.
    33

    View full-size slide


  30. Who are you creating for?
    ● What are they trying to achieve?
    ● Why are you creating this?

    View full-size slide

  31. Get Development
    Right
    35

    View full-size slide

  32. Instead of focusing on CRUD, focus on
    goals and the sequence of actions
    required to achieve them.

    View full-size slide

  33. ● Scalability
    ● Maintainability
    ● Security
    ● Reliability
    ● Performance
    ● Testing

    View full-size slide

  34. 38
    Your APIs should hide complexities and
    not expose them

    View full-size slide

  35. 39
    Is the API service delivering on the strategic
    goals?
    Is the API service quality enough to support the
    strategic goals?
    Track Effectiveness

    View full-size slide

  36. 40
    Questions?

    View full-size slide