Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
How to Build a
Great Web API
James Higginbotham
james@launchany.com
@launchany
The World of APIs
Estimated 100-200k APIs
We help API developers go
from…
…to this
APIs Are More Than Code
Applications - Business Capabilities
Data – Inbound and Outbound
Devices – Always on/Sometimes on
...
Developer Experience (“DX”)
Developer Experience is to Developers
as
User Experience is to Users
9
Make It Easy To Love Your API
1) Great documentation
Bad Developer Experience
Swagger for API docs
Interactive = “Try It Out!”
Make It Easy To Love Your API
1) Great documentation
2) Simple examples
Twilio Example
Make It Easy To Love Your API
1) Interactive documentation
2) Great examples
3) Consistent
Not REST!
REST!
How can we ensure a great
developer experience?
Modeling REST APIs
Similar to wireframing or domain modeling
REST focuses on resources
Resources can be entities and workf...
5 Steps to API Modeling
1. Identify the participants
2. Identify the activities
3. Separate the activities into steps
4. L...
Modeling is Fun
The goal is to design a beautiful API
Involve your entire team:
Developers, QA, Business Analysts
Product ...
Thank you!
http://bit.ly/better-apis
james@launchany.com
@launchany
How to Design and Build a Great Web API
Upcoming SlideShare
Loading in …5
×

How to Design and Build a Great Web API

1,081 views

Published on

APIs and API-first strategies are quickly becoming important for software product companies. These slides are from a lightning talk discussing why developer experience should be your #1 concern when launching a web API, and how everyone on your team can contribute to the process through the practice of API modeling.

Published in: Software, Technology, Business
  • Be the first to comment

How to Design and Build a Great Web API

  1. 1. How to Build a Great Web API James Higginbotham james@launchany.com @launchany
  2. 2. The World of APIs
  3. 3. Estimated 100-200k APIs
  4. 4. We help API developers go from…
  5. 5. …to this
  6. 6. APIs Are More Than Code Applications - Business Capabilities Data – Inbound and Outbound Devices – Always on/Sometimes on Workflow - orchestration People – users and developers 6
  7. 7. Developer Experience (“DX”) Developer Experience is to Developers as User Experience is to Users
  8. 8. 9
  9. 9. Make It Easy To Love Your API 1) Great documentation
  10. 10. Bad Developer Experience
  11. 11. Swagger for API docs
  12. 12. Interactive = “Try It Out!”
  13. 13. Make It Easy To Love Your API 1) Great documentation 2) Simple examples
  14. 14. Twilio Example
  15. 15. Make It Easy To Love Your API 1) Interactive documentation 2) Great examples 3) Consistent
  16. 16. Not REST!
  17. 17. REST!
  18. 18. How can we ensure a great developer experience?
  19. 19. Modeling REST APIs Similar to wireframing or domain modeling REST focuses on resources Resources can be entities and workflows Modeling enhances our understanding
  20. 20. 5 Steps to API Modeling 1. Identify the participants 2. Identify the activities 3. Separate the activities into steps 4. List resources and methods 5. Validate for completeness
  21. 21. Modeling is Fun The goal is to design a beautiful API Involve your entire team: Developers, QA, Business Analysts Product Owners, Subject Matter Experts Have fun with it!
  22. 22. Thank you!
  23. 23. http://bit.ly/better-apis james@launchany.com @launchany

×