Building APIs with Node.js and Swagger

•Descargar como PPTX, PDF•

11 recomendaciones•5,682 vistas

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.

Tecnología

Building APIs in Node.js with Swagger
Jeremy Whitlock

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

Input Contract
APIs Define an Interaction Model

Output Contract
APIs Define an Interaction Model

Without documentation…
… how can you expect
developers to get in?

Swagger is a specification to describe APIs.

Swagger Documents
• Written in JSON or YAML
• Clearly describe:
–Available APIs
–API input contract
–API output contract
–Required authn/authz
–Success/Error responses
–…
• Extensible

Swagger
Mixing Swagger with Code
Duplication

Swagger-Driven APIs
Swagger: Not just for
documentation!

Swagger-Driven APIs
Swagger
Swagger Metadata
Routing
Security
Request Validation
Response Validation
Business Logic

There is no wrong approach.
Use what makes sense for you.

swagger-editor (http://editor.swagger.io/)

Más contenido relacionado

La actualidad más candente

Helps you to understand Swagger and its practical uses for representing REST APIs. You’ll learn some ways to get started. We’ll survey some of the tools and resources for describing REST APIs with Swagger. We’ll talk about what Swagger is (a specification and framework) — and isn’t (merely another doc tool). We’ll talk about the pros and cons of the Swagger-UI. And we’ll look at how Swagger helps people to learn about and explore an API.

A Tour of Swagger for APIs

Allen Dean

Swagger is a specification and complete framework implementation for describing, producing, consuming, and visualizing RESTful web services. The overarching goal of Swagger is to enable client and documentation systems to update at the same pace as the server. The documentation of methods, parameters, and models are tightly integrated into the server code, allowing APIs to always stay in sync. With Swagger, deploying managing, and using powerful APIs has never been easier.

Documenting your REST API with Swagger - JOIN 2014

JWORKS powered by Ordina

companion tutorial: https://medium.com/@augusteo/streamlining-api-with-swagger-io-9f20470d2f42#.twnbi4gr5 Learn about the way Swagger stack and OpenAPI-spec can help you and your team to design, develop and implement API server, client and documentation. In this talk we will explore what Swagger is, how it can help you streamline your team's API development. The finale will be a live demo on how to deploy Ruby Sinatra API server and Swift iOS client using the Swagger code generation in 5 minutes.

Streamlining API with Swagger.io

Victor Augusteo

Design Driven API Development

Sokichi Fujita

Developing Faster with Swagger

Tony Tam

Swagger 2.0 and Model-driven APIs

Apigee | Google Cloud

Introducing Swagger

Tony Tam

Introducing swagger

Amr Ali

Swagger

NexThoughts Technologies

Level 3 REST Makes Your API Browsable

Matt Bishop

Designing APIs with OpenAPI Spec

Adam Paxton

Whether you’re new to Swagger, or have already been using the framework for API design, there’s a good chance you still have questions about how to improve your API documentation. Creating API documentation your consumers will love can take some work, but the investment will have a significant payoff in the form of a great developer experience, easier implementation, and improved adoption of your API. This presentation covers good developer experience in detail, focusing on why and how to provide an optimal experience for developers using your API. We will also cover how Swagger has changed the API design and documentation landscape, and finally show some good practices for API documentation using Swagger in SwaggerHub’s integrated API development platform. Things to expect in this webinar: What is Developer Experience (DX)? What does it mean for an API to have good DX? API documentation in the context of good DX? An introduction to the Swagger framework Designing APIs from a usability perspective using Swagger and SwaggerHub

API Developer Experience: Why it Matters, and How Documenting Your API with S...

SmartBear

Understanding how to use Swagger and its tools

Swagger API

Swagger / Quick Start Guide

Andrii Gakhov

Learn how to better communicate between Python services. We'll use simple-to-follow examples and go from a service with undocumented endpoints to one which has full docs and validation on requests. Learn how to use Swagger tooling for python, including the bravado (client) and pyramid_swagger (server) libraries. In the end, you'll (hopefully!) find nirvana and make the machines do all the hard work for you.

Crystal clear service interfaces w/ Swagger/OpenAPI

Scott Triglia

Presented at JavaOne 2016. Using Swagger has become the most popular way to describe REST APIs across the web, enabling people to more quickly understand and communicate with services, with developer-friendly documentation and rich, autogenerated client SDKs. As the API has moved more into being one of the most important aspects of a service, the Swagger definition has become increasingly more important and essential to the design phase. This presentation explains how the Swagger definition can be used to streamline the iteration process and enable client and server engineers to develop concurrently with complex APIs.

API Design first with Swagger

Tony Tam

Swagger provides a clean contract for your REST API. Swagger Inflector is a project which uses Swagger as the language of the API, automatically wiring REST endpoints directly to controllers in the Jersey 2.x framework. By doing so, the specification and code are always up to date, removing potentially error-prone redundant code and bringing development on the JDK up to speed with typeless languages.

Writer APIs in Java faster with Swagger Inflector

Tony Tam

Swagger 2.0: Latest and Greatest

LaunchAny

What is Swagger?

Philip Senger

This session will show you how you can easily document your REST API's using Spring & Swagger. It will show you how to use the Swagger-Spring integration in a Spring Boot application: Setup a basic REST API using Spring-Boot together with Swagger-Springfox Access and test the REST-API using the Swagger-UI client Generate client code stubs for your language (e.g. Java, PHP, Python, ...) using Swagger-Codegen Graphically display your REST-API using the Chrome plugin Swagger.ed Devoxx Belgium Nov. 2015

Document your rest api using swagger - Devoxx 2015

johannes_fiala

La actualidad más candente (20)

A Tour of Swagger for APIs

Documenting your REST API with Swagger - JOIN 2014

Streamlining API with Swagger.io

Design Driven API Development

Developing Faster with Swagger

Swagger 2.0 and Model-driven APIs

Introducing Swagger

Introducing swagger

Swagger

Level 3 REST Makes Your API Browsable

Designing APIs with OpenAPI Spec

API Developer Experience: Why it Matters, and How Documenting Your API with S...

Understanding how to use Swagger and its tools

Swagger / Quick Start Guide

Crystal clear service interfaces w/ Swagger/OpenAPI

API Design first with Swagger

Writer APIs in Java faster with Swagger Inflector

Swagger 2.0: Latest and Greatest

What is Swagger?

Document your rest api using swagger - Devoxx 2015

Destacado

Why is Node.js a good choice for building APIs? What is Swagger 2.0 and how can you use it to create your API documentation? Join Jeff West and Marsh Gardiner for a code and demo-filled session, in which we’ll design an API with Swagger 2.0 and then implement and deploy the API in Node.js on both Apigee and AWS. We will 'show the code’ to: • Build production-grade APIs in Node.js with Apigee-127 • Create API documentation with Swagger 2.0 • Add enterprise capabilities like OAuth, quota, caching, and analytics using NPMs (Node Package Manager) • Deploy to any PaaS, including Apigee, Amazon AWS, and Heroku View video: http://youtu.be/Fw43z14Y1Xw View podcast: https://soundcloud.com/apigee/build-apis-in-nodejs-and-swagger-20-with-apigee-127

Build APIs in Node.js and Swagger 2.0 with Apigee-127

Apigee | Google Cloud

API Docs Made Right / RAML - Swagger rant

Vladimir Shulyak

Swagger code motion talk

Victor Trakhtenberg

I Love APIs 2015 API Lab Design-first API Development Using Node and Swagger

Apigee | Google Cloud

OpenAPI Specification概要

Kazuchika Sekiya

Swagger 入門

Yoshiaki Yoshida

Workshop Guide: RESTful Java Web Application with Spring Boot

Fabricio Epaminondas

Workshop: Building a Streaming Data Platform on AWS

Amazon Web Services

Seeing is Believing: Free Versus Premium

Destacado (9)

Build APIs in Node.js and Swagger 2.0 with Apigee-127

API Docs Made Right / RAML - Swagger rant

Swagger code motion talk

I Love APIs 2015 API Lab Design-first API Development Using Node and Swagger

OpenAPI Specification概要

Swagger 入門

Workshop Guide: RESTful Java Web Application with Spring Boot

Workshop: Building a Streaming Data Platform on AWS

Seeing is Believing: Free Versus Premium

Similar a Building APIs with Node.js and Swagger

Swagger for startups

Tony Tam

I Love APIs 2015: Create Design-driven APIs with Node.js and Swagger

Apigee | Google Cloud

APIdays Paris 2019 - API Descriptions as Product Code by Phil Sturgeon, Stopl...

apidays

Open API Specifications - formerly swagger

Pradeep Kumar

John Feeney - The Importance of APIs and Headless technology In Digital Tran...

John Feeney

API-First Design and Django

Klaus Peter Laube

Project onion with swagger

Abhinav Jha

MVP with GWT and GWTP

Christian Goudreau

In this comprehensive tutorial on Spring Boot Swagger UI, we dive into the powerful combination of Spring Boot and Swagger to simplify API documentation and testing. Spring Boot is a popular framework for building Java applications, while Swagger is an open-source set of rules, specifications, and tools for developing and describing RESTful APIs. With Swagger UI, developers can create interactive and human-readable API documentation effortlessly. In this video, we cover the following key topics: Introduction to Spring Boot and Swagger UI Setting up a Spring Boot project Integrating Swagger UI into a Spring Boot application Configuring Swagger annotations to document APIs Generating interactive API documentation with Swagger UI Customizing the Swagger UI interface Leveraging Swagger for API testing and exploration Best practices for using Spring Boot Swagger UI By the end of this tutorial, you'll have a solid understanding of how to integrate Swagger UI with your Spring Boot projects, enabling you to easily document, explore, and test your APIs. Whether you're a beginner or an experienced developer, this video will provide you with the necessary knowledge to leverage the power of Spring Boot Swagger UI. https://www.youtube.com/@CodeWithBisky

Learn Spring Boot With Bisky - Swagger

MarshallChabaga

Spec-first API design dramatically tightens and improves the development feedback loop without wasting effort on artifacts that can't be used. The Jira Software team has used this approach very successfully to build APIs that we expose to both internal and external consumers. In this session, James Navin will walk you through the spec-first approach and demonstrate the benefits that it brings. He will also highlight some tools that can be used to implement a spec-first development approach.

Spec-first API Design for Speed and Safety

Atlassian

API Athens Meetup - API standards 25-6-2014

openi_ict

API Athens Meetup - API standards 25-6-2014

Michael Petychakis

ProgrammableWeb's eSignature API Research Report

ProgrammableWeb

API SECURITY

Tubagus Rizky Dharmawan

Customer-facing and internal APIs have become the most common way to integrate the components of web-based software. Using standards like OpenAPI, you can provide reliable, easy-to-use interfaces that allow other developers safe, controlled access to your software. Designing APIs with Swagger and OpenAPI is a hands-on primer to properly designing and describing your APIs using the most widely-adopted standard. If you want to learn more about the book, follow this link: https://www.manning.com/books/designing-apis-with-swagger-and-openapi?utm_source=slideshare&utm_medium=social&utm_campaign=book_designingapiswithswaggerandopenapi&utm_content=slideshare_01

Designing APIs with Swagger and OpenAPI

Manning Publications

WSO2Con Asia 2014 - Building the API-Centric Enterprise

WSO2

API.docx

RichwellIanAfrica

API Security has become an important concern in recent times as organizations are more cautious about exposing raw, sensitive data via APIs. Therefore, it is important that APIs adhere to the OpenAPI Specification (OAS) to ensure API security. WSO2 has partnered with 42Crunch, to bring in the ability to conduct a security audit on the OpenAPI Specification definition, and to obtain an audit report. The WSO2 API Manager 3.1 brings a lot of interesting features, including the ability to run 42Crunch’s audit tool directly from the API Publishing portal. In this webinar, we will: - Explain the advantages of introducing security at design time - Introduce the 42Crunch audit functionality - Explain how 42Crunch and WSO2 API Manager can be used together for better API Security

42Crunch Security Audit for WSO2 API Manager 3.1

WSO2

Google Developer Groups, Why We Choose Angular.js

Almog Koren

API Description Languages: Which Is The Right One For Me?

ProgrammableWeb

Similar a Building APIs with Node.js and Swagger (20)

Swagger for startups

I Love APIs 2015: Create Design-driven APIs with Node.js and Swagger

APIdays Paris 2019 - API Descriptions as Product Code by Phil Sturgeon, Stopl...

Open API Specifications - formerly swagger

John Feeney - The Importance of APIs and Headless technology In Digital Tran...

API-First Design and Django

Project onion with swagger

MVP with GWT and GWTP

Learn Spring Boot With Bisky - Swagger

Spec-first API Design for Speed and Safety

API Athens Meetup - API standards 25-6-2014

ProgrammableWeb's eSignature API Research Report

API SECURITY

Designing APIs with Swagger and OpenAPI

WSO2Con Asia 2014 - Building the API-Centric Enterprise

API.docx

42Crunch Security Audit for WSO2 API Manager 3.1

Google Developer Groups, Why We Choose Angular.js

API Description Languages: Which Is The Right One For Me?

Último

Scaling API-first – The story of a global engineering organization Ian Reasor, Senior Computer Scientist - Adobe Radu Cotescu, Senior Computer Scientist - Adobe Apidays New York 2024: The API Economy in the AI Era (April 30 & May 1, 2024) ------ Check out our conferences at https://www.apidays.global/ Do you want to sponsor or talk at one of our conferences? https://apidays.typeform.com/to/ILJeAaV8 Learn more on APIscene, the global media made by the community for the community: https://www.apiscene.io Explore the API ecosystem with the API Landscape: https://apilandscape.apiscene.io/

Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe

apidays

Manulife - Insurer Transformation Award 2024

The Digital Insurer

AWS Community Day CPH - Three problems of Terraform

Andrey Devyatkin

presentation ICT roal in 21st century education

jfdjdjcjdnsjd

Emergent Methods: Multi-lingual narrative tracking in the news - real-time ex...

Zilliz

2024: Domino Containers - The Next Step. News from the Domino Container commu...

Martijn de Jong

Repurposing LNG terminals for Hydrogen Ammonia: Feasibility and Cost Saving

Edi Saputra

Exploring Multimodal Embeddings with Milvus

Zilliz

💥 You’re lucky! We’ve found two different (lead) developers that are willing to share their valuable lessons learned about using UiPath Document Understanding! Based on recent implementations in appealing use cases at Partou and SPIE. Don’t expect fancy videos or slide decks, but real and practical experiences that will help you with your own implementations. 📕 Topics that will be addressed: • Training the ML-model by humans: do or don't? • Rule-based versus AI extractors • Tips for finding use cases • How to start 👨‍🏫👨‍💻 Speakers: o Dion Morskieft, RPA Product Owner @Partou o Jack Klein-Schiphorst, Automation Developer @Tacstone Technology

DEV meet-up UiPath Document Understanding May 7 2024 Amsterdam

UiPathCommunity

DBX First Quarter 2024 Investor Presentation

Dropbox

"I see eyes in my soup": How Delivery Hero implemented the safety system for ...

Zilliz

The action of the next cyber saga takes place in the mystical lands of the Asia-Pacific region, where the main characters began their digital activities in the middle of 2021 and qualitatively strengthened it in 2022. Corporate espionage, document theft, audio recordings, and data leaks from messaging platforms were all a matter of one day for Dark Pink. Their geographical focus may have started in the Asia-Pacific region, but their ambitions knew no bounds, targeting a European government ministry in a bold move to expand their portfolio. Their victim profile was as diverse as a UN meeting, targeting military organizations, government agencies, and even a religious organization. Because discrimination is not a fashionable agenda. In the world of cybercrime, they serve as a reminder that sometimes the most serious threats come in the most unassuming packages with a pink bow.

Cyberprint. Dark Pink Apt Group [EN].pdf

Overkill Security

💉💊+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHABI}}+971581248768 +971581248768 Mtp-Kit (500MG) Prices » Dubai [(+971581248768**)] Abortion Pills For Sale In Dubai, UAE, Mifepristone and Misoprostol Tablets Available In Dubai, UAE CONTACT DR.Maya Whatsapp +971581248768 We Have Abortion Pills / Cytotec Tablets /Mifegest Kit Available in Dubai, Sharjah, Abudhabi, Ajman, Alain, Fujairah, Ras Al Khaimah, Umm Al Quwain, UAE, Buy cytotec in Dubai +971581248768''''Abortion Pills near me DUBAI | ABU DHABI|UAE. Price of Misoprostol, Cytotec” +971581248768' Dr.DEEM ''BUY ABORTION PILLS MIFEGEST KIT, MISOPROTONE, CYTOTEC PILLS IN DUBAI, ABU DHABI,UAE'' Contact me now via What's App…… abortion Pills Cytotec also available Oman Qatar Doha Saudi Arabia Bahrain Above all, Cytotec Abortion Pills are Available In Dubai / UAE, you will be very happy to do abortion in Dubai we are providing cytotec 200mg abortion pill in Dubai, UAE. Medication abortion offers an alternative to Surgical Abortion for women in the early weeks of pregnancy. We only offer abortion pills from 1 week-6 Months. We then advise you to use surgery if its beyond 6 months. Our Abu Dhabi, Ajman, Al Ain, Dubai, Fujairah, Ras Al Khaimah (RAK), Sharjah, Umm Al Quwain (UAQ) United Arab Emirates Abortion Clinic provides the safest and most advanced techniques for providing non-surgical, medical and surgical abortion methods for early through late second trimester, including the Abortion By Pill Procedure (RU 486, Mifeprex, Mifepristone, early options French Abortion Pill), Tamoxifen, Methotrexate and Cytotec (Misoprostol). The Abu Dhabi, United Arab Emirates Abortion Clinic performs Same Day Abortion Procedure using medications that are taken on the first day of the office visit and will cause the abortion to occur generally within 4 to 6 hours (as early as 30 minutes) for patients who are 3 to 12 weeks pregnant. When Mifepristone and Misoprostol are used, 50% of patients complete in 4 to 6 hours; 75% to 80% in 12 hours; and 90% in 24 hours. We use a regimen that allows for completion without the need for surgery 99% of the time. All advanced second trimester and late term pregnancies at our Tampa clinic (17 to 24 weeks or greater) can be completed within 24 hours or less 99% of the time without the need surgery. The procedure is completed with minimal to no complications. Our Women's Health Center located in Abu Dhabi, United Arab Emirates, uses the latest medications for medical abortions (RU-486, Mifeprex, Mifegyne, Mifepristone, early options French abortion pill), Methotrexate and Cytotec (Misoprostol). The safety standards of our Abu Dhabi, United Arab Emirates Abortion Doctors remain unparalleled. They consistently maintain the lowest complication rates throughout the nation. Our Physicians and staff are always available to answer questions and care for women in one of the most difficult times in their lives. The decision to have an abortion at the Abortion Cl

+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...

?#DUbAI#??##{{(☎️+971_581248768%)**%*]'#abortion pills for sale in dubai@

Architecting Cloud Native Applications

WSO2

Corporate and higher education. Two industries that, in the past, have had a clear divide with very little crossover. The difference in goals, learning styles and objectives paved the way for differing learning technologies platforms to evolve. Now, those stark lines are blurring as both sides are discovering they have content that’s relevant to the other. Join Tammy Rutherford as she walks through the pros and cons of corporate and higher ed collaborating. And the challenges of these different technology platforms working together for a brighter future.

Corporate and higher education May webinar.pptx

Rustici Software

[BuildWithAI] Introduction to Gemini.pdf

Sandro Moreira

The microservices honeymoon is over. When starting a new project or revamping a legacy monolith, teams started looking for alternatives to microservices. The Modular Monolith, or 'Modulith', is an architecture that reaps the benefits of (vertical) functional decoupling without the high costs associated with separate deployments. This talk will delve into the advantages and challenges of this progressive architecture, beginning with exploring the concept of a 'module', its internal structure, public API, and inter-module communication patterns. Supported by spring-modulith, the talk provides practical guidance on addressing the main challenges of a Modultith Architecture: finding and guarding module boundaries, data decoupling, and integration module-testing. You should not miss this talk if you are a software architect or tech lead seeking practical, scalable solutions. About the author With two decades of experience, Victor is a Java Champion working as a trainer for top companies in Europe. Five thousands developers in 120 companies attended his workshops, so he gets to debate every week the challenges that various projects struggle with. In return, Victor summarizes key points from these workshops in conference talks and online meetups for the European Software Crafters, the world’s largest developer community around architecture, refactoring, and testing. Discover how Victor can help you on victorrentea.ro : company training catalog, consultancy and YouTube playlists.

Modular Monolith - a Practical Alternative to Microservices @ Devoxx UK 2024

Victor Rentea

Effective data discovery is crucial for maintaining compliance and mitigating risks in today's rapidly evolving privacy landscape. However, traditional manual approaches often struggle to keep pace with the growing volume and complexity of data. Join us for an insightful webinar where industry leaders from TrustArc and Privya will share their expertise on leveraging AI-powered solutions to revolutionize data discovery. You'll learn how to: - Effortlessly maintain a comprehensive, up-to-date data inventory - Harness code scanning insights to gain complete visibility into data flows leveraging the advantages of code scanning over DB scanning - Simplify compliance by leveraging Privya's integration with TrustArc - Implement proven strategies to mitigate third-party risks Our panel of experts will discuss real-world case studies and share practical strategies for overcoming common data discovery challenges. They'll also explore the latest trends and innovations in AI-driven data management, and how these technologies can help organizations stay ahead of the curve in an ever-changing privacy landscape.

TrustArc Webinar - Unlock the Power of AI-Driven Data Discovery

TrustArc

How to Troubleshoot Apps for the Modern Connected Worker

ThousandEyes

AXA XL - Insurer Innovation Award Americas 2024

The Digital Insurer

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