handy tools for designing great...
TRANSCRIPT
![Page 1: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/1.jpg)
Handy Tools for Designing Great APIs
Mike Amundsen@mamund
![Page 2: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/2.jpg)
![Page 3: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/3.jpg)
training.amundsen.com
![Page 4: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/4.jpg)
http://g.mamund.com/cambook
"A reusable guide to the technology, business, and politics of doing APIs
at scale within the enterprise."
-- Kin Lane, API Evangelist
![Page 5: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/5.jpg)
Designing Great APIs
● APIs as a Product● Design Thinking● An API Design Method● Virtuous Cycle
![Page 6: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/6.jpg)
APIs as a Product
![Page 7: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/7.jpg)
![Page 8: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/8.jpg)
![Page 9: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/9.jpg)
![Page 10: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/10.jpg)
![Page 11: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/11.jpg)
![Page 12: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/12.jpg)
APIabbreviation1. application programming interface
![Page 13: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/13.jpg)
![Page 14: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/14.jpg)
![Page 15: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/15.jpg)
good APIs make interaction easy
![Page 16: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/16.jpg)
Design Thinking
![Page 17: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/17.jpg)
![Page 18: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/18.jpg)
Design Thinking
A design discipline to match people’s needs with what is technologically
feasible and what a viable business strategy can convert into customer
value and market opportunity.
-- Tim Brown, CEO of IDEO
![Page 19: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/19.jpg)
Design Thinking
A design discipline to match people’s needs with what is technologically
feasible and what a viable business strategy can convert into customer
value and market opportunity.
-- Tim Brown, CEO of IDEO
![Page 20: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/20.jpg)
Design Thinking
A design discipline to match people’s needs with what is technologically feasible and what a viable business
strategy can convert into customer value and market opportunity.
-- Tim Brown, CEO of IDEO
![Page 21: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/21.jpg)
Design Thinking
A design discipline to match people’s needs with what is technologically
feasible and what a viable business strategy can convert into customer
value and market opportunity.
-- Tim Brown, CEO of IDEO
![Page 22: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/22.jpg)
Design Thinking
A design discipline to match people’s needs with what is technologically
feasible and what a viable business strategy can convert into customer
value and market opportunity.
-- Tim Brown, CEO of IDEO
![Page 23: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/23.jpg)
Design Thinking
A design discipline to match people’s needs with what is technologically
feasible and what a viable business strategy can convert into customer
value and market opportunity.
-- Tim Brown, CEO of IDEO
![Page 24: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/24.jpg)
Three Elements of Design
![Page 25: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/25.jpg)
Few people think about it or are aware of it. But there is nothing made by human beings that does not involve a design decision somewhere.
“”
Bill MoggridgeInteraction Design Pioneer
![Page 26: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/26.jpg)
FunctionalityUsabilityExperience
design
![Page 27: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/27.jpg)
http://www.flickr.com/photos/monicamuller/3171329060
toast
![Page 28: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/28.jpg)
Functionality
http://www.flickr.com/photos/traviswiens/3761198872/
![Page 29: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/29.jpg)
Usability
![Page 30: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/30.jpg)
Experience
![Page 31: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/31.jpg)
Three Elements of Design
● Functionality● Usability● Experience
![Page 32: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/32.jpg)
An API Design Method
![Page 33: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/33.jpg)
![Page 34: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/34.jpg)
API Design Method
● API Workflow● API Diagram● API Vocabulary● API Profile● API Reference
![Page 35: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/35.jpg)
Produce a Workflow Sketch
![Page 36: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/36.jpg)
Workflow Sketch: Weather API
![Page 37: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/37.jpg)
Draw a Diagram
![Page 38: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/38.jpg)
Diagram: Weather API
![Page 39: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/39.jpg)
![Page 40: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/40.jpg)
WSD format documents
![Page 41: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/41.jpg)
Diagram: Weather API
![Page 42: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/42.jpg)
![Page 43: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/43.jpg)
![Page 44: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/44.jpg)
Bonus Utility -- wsdgen
● CLI app to generate images from WSD format docs
wsdgen weatherAPI.wsd
![Page 45: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/45.jpg)
Apply Vocabularies
![Page 46: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/46.jpg)
Weather Data
● Gather all the property names● Gather all the action names● Normalize vocabularies
○ Open○ Industry○ Internal
![Page 47: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/47.jpg)
Before Applying Vocabularies
![Page 48: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/48.jpg)
Sources for Vocabularies
▪IANA Link Relation Values▪schema.org, Activity Streams▪microformats, Dublin Core▪Industry Vocabularies (Semantic Sensor Web)▪Internal Vocabularies
![Page 49: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/49.jpg)
After Applying Vocabularies
![Page 50: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/50.jpg)
After Applying Vocabularies
Normalize Properties & Specify Actions
![Page 51: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/51.jpg)
Create a Description Document
![Page 52: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/52.jpg)
Description vs. Definitions
▪ Describing the interface doesn't define it.▪ Description languages
▪ ALPS▪ DCAP▪ JSON Home
▪ Definition languages▪ WSDL▪ Swagger▪ RAML▪ Blueprint
![Page 53: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/53.jpg)
Description vs. Definitions
▪ Describing the interface doesn't define it.▪ Description languages
▪ ALPS▪ DCAP▪ JSON Home
▪ Definition languages▪ WSDL▪ Swagger▪ RAML▪ Blueprint
![Page 54: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/54.jpg)
![Page 55: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/55.jpg)
Bonus Utility -- wsd2alps
● CLI app to generate ALPS doc from WSD doc
wsd2alps weatherAPI.wsd weather-alps.json
![Page 56: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/56.jpg)
![Page 57: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/57.jpg)
Generate reference API documentation
![Page 58: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/58.jpg)
API Reference Documentation
● Simple reference docs are handy● But insufficient● Many aspects to human documentation
○ Concepts○ Getting Started○ Common Tasks○ Solving Problems○ Detailed Reference
![Page 59: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/59.jpg)
![Page 60: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/60.jpg)
Bonus Utility -- alps2doc
● CLI app to generate reference doc from ALPS doc
alps2doc weatherAPI.wsd weatherAPI.md
![Page 61: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/61.jpg)
Design Artifacts
▪Workflow Sketch (doc)▪Diagram (wsdgen)▪Description Document (wsd2alps)▪Generate Reference Doc (alps2doc)
Check these into source control
![Page 62: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/62.jpg)
And So...
![Page 63: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/63.jpg)
APIs as Products
![Page 64: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/64.jpg)
Design Thinking
![Page 65: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/65.jpg)
API Design Method
![Page 66: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/66.jpg)
Virtuous Cycle of Design
![Page 67: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/67.jpg)
Available Online...
● Slides (amundsen.com/talks)● Utilities (github.com/api-tool-kit)● Newsletter (g.mamund.com/newsletter)● Books (amazon.com/Michael-Amundsen)
![Page 68: Handy Tools for Designing Great APIsamundsen.com/talks/2019-03-ndc-porto/2019-03-porto-handy-tools.pdf · Designing Great APIs APIs as a Product Design Thinking An API Design Method](https://reader034.vdocument.in/reader034/viewer/2022050503/5f9586ae97a0f54ae919e7e8/html5/thumbnails/68.jpg)
Handy Tools for Designing Great APIs
Mike Amundsen@mamund
Thanks!