Building APIs with Node.js and Swagger
•11 likes•5,681 views
Report
Share
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.
More Related Content
What's hot
What's hot(20)
Viewers also liked
Viewers also liked(9)
Similar to Building APIs with Node.js and Swagger
Similar to Building APIs with Node.js and Swagger(20)
Recently uploaded
Recently uploaded(20)
![[2023] Putting the R! in R&D.pdf](https://cdn.slidesharecdn.com/ss_thumbnails/2023puttingtherinrd-231122234738-294b2909-thumbnail.jpg?width=768&fit=bounds)
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?
- 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
- 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
- 24. > npm install swagger
- 27. Write your spec and docs render live
- 28. Shareable spec and mock server
- 29. But it doesn't end there…
- 30. Thank you