Building APIs with Node.js and Swagger

Jeremy Whitlock

•

May. 22, 2015

• •

Building APIs in Node.js with Swagger
Jeremy Whitlock

What is an API?

An API is an “application programming
interface”… the interface for interaction.

Next SlideShares

Upcoming SlideShare

Rest API with Swagger and NodeJS

Rest API with Swagger and NodeJS

Loading in …3

×

Building APIs with Node.js and Swagger

May. 22, 2015

• •

Download to read offline

This talk started with a quick description of APIs and the importance of good documentation. We then introduced Swagger, talked about how/why it helps in solving this process. Finally, we talked about a number of Node.js tools we've built to help make API design, API development and better overall APIs using Node.js and Swagger.

Jeremy Whitlock

Software Architect

This talk started with a quick description of APIs and the importance of good documentation. We then introduced Swagger, talked about how/why it helps in solving this process. Finally, we talked about a number of Node.js tools we've built to help make API design, API development and better overall APIs using Node.js and Swagger.

More Related Content

The Future Is Faster Than You Think: How Converging Technologies Are Transforming Business, Industries, and Our Lives Peter H. Diamandis

SAM: One Robot, a Dozen Engineers, and the Race to Revolutionize the Way We Build Jonathan Waldman

From Gutenberg to Google: The History of Our Future Tom Wheeler

Talk to Me: How Voice Computing Will Transform the Way We Live, Work, and Think James Vlahos

So You Want to Start a Podcast: Finding Your Voice, Telling Your Story, and Building a Community That Will Listen Kristen Meinzer

Bezonomics: How Amazon Is Changing Our Lives and What the World's Best Companies Are Learning from It Brian Dumaine

Autonomy: The Quest to Build the Driverless Car—And How It Will Reshape Our World Lawrence D. Burns

No Filter: The Inside Story of Instagram Sarah Frier

Future Presence: How Virtual Reality Is Changing Human Connection, Intimacy, and the Limits of Ordinary Life Peter Rubin

Live Work Work Work Die: A Journey into the Savage Heart of Silicon Valley Corey Pein

Life After Google: The Fall of Big Data and the Rise of the Blockchain Economy George Gilder

Everybody Lies: Big Data, New Data, and What the Internet Can Tell Us About Who We Really Are Seth Stephens-Davidowitz

Energy Conservation in Buildings: The Achievement of 50% Energy Saving: An Environmental Challenge? Elsevier Books Reference

Longitude: The True Story of a Lone Genius Who Solved the Greatest Scientific Problem of His Time Dava Sobel

Young Men and Fire: Twenty-fifth Anniversary Edition Norman Maclean

System Identification: Tutorials Presented at the 5th IFAC Symposium on Identification and System Parameter Estimation, F.R. Germany, September 1979 Elsevier Books Reference

The Quiet Zone: Unraveling the Mystery of a Town Suspended in Silence Stephen Kurczy

An Ugly Truth: Inside Facebook’s Battle for Domination Sheera Frenkel

A Brief History of Motion: From the Wheel, to the Car, to What Comes Next Tom Standage

Driven: The Race to Create the Autonomous Car Alex Davies

Test Gods: Virgin Galactic and the Making of a Modern Astronaut Nicholas Schmidle

Spooked: The Trump Dossier, Black Cube, and the Rise of Private Spies Barry Meier

Second Nature: Scenes from a World Remade Nathaniel Rich

After Steve: How Apple Became a Trillion-Dollar Company and Lost its Soul Tripp Mickle

Dignity in a Digital Age: Making Tech Work for All of Us Ro Khanna

Einstein's Fridge: How the Difference Between Hot and Cold Explains the Universe Paul Sen

User Friendly: How the Hidden Rules of Design Are Changing the Way We Live, Work, and Play Cliff Kuang

A World Without Work: Technology, Automation, and How We Should Respond Daniel Susskind

Uncanny Valley: A Memoir Anna Wiener

Blockchain: The Next Everything Stephen P. Williams

Lean Out: The Truth About Women, Power, and the Workplace Marissa Orr

Bitcoin Billionaires: A True Story of Genius, Betrayal, and Redemption Ben Mezrich

Building APIs with Node.js and Swagger

1. Building APIs in Node.js with Swagger Jeremy Whitlock
2. What is an API?
3. An API is an “application programming interface”… the interface for interaction.
4. API APIs are Building Blocks
5. APIs in the Physical World
6. Input Contract APIs Define an Interaction Model
7. Output Contract APIs Define an Interaction Model
8. Without documentation… … how can you expect developers to get in?
9. What is Swagger? http://swagger.io
10. Swagger is a specification to describe APIs.
11. Swagger emerges as an industry standard
12. Swagger Documents • Written in JSON or YAML • Clearly describe: –Available APIs –API input contract –API output contract –Required authn/authz –Success/Error responses –… • Extensible
13. It is much more than just Swagger-UI!
14. How Do People Use Swagger?
15. Swagger Mixing Swagger with Code
16. Swagger Mixing Swagger with Code Duplication
17. Code Without Swagger
18. Swagger-Driven APIs Swagger: Not just for documentation!
19. Swagger-Driven APIs Swagger Swagger Metadata Routing Security Request Validation Response Validation Business Logic
20. There is no wrong approach. Use what makes sense for you.
21. Swagger tooling for Node.js (and more)
22. > npm install swagger-tools
23. swagger-editor (http://editor.swagger.io/)
24. > npm install swagger
25. Announcing: apistudio.io
26. Write your spec and docs render live
27. Shareable spec and mock server
28. But it doesn't end there…
29. Thank you