Beyond the basic Swagger UI: Adyen API Explorer

•

2 likes•3,202 views

OpenAPI/Swagger has rapidly become the next standard in the world of API documentation. But Swagger UI, used by most API portals, is far from ideal. At Adyen we reimagined Swagger implementation resulting in a new API Explorer; and this is my talk at API The Docs Amsterdam, where I shared the lessons learnt by our team.

Adyen API Explorer
Beyond the basic Swagger UI
wherever people payAleksei Akimov

Adyen accepts payments
over any sales channel

Adyen: 250+ payment methods
China
Netherlands
France
UKBelgium
World
Canada
US
Mexico
Portugal
Europe
Russia
Sweden
South Korea
Austria
Poland
Malaysia
Japan
Philippines
Indonesia
Australia
Thailand
Denmark
Germany
Finland
Brasil

2008 2010 2012 2014 2016
Annual processing: over $100B
2017

Docs: Main
challenges
• Release cycle: 3-4 weeks
• 10+ APIs, different versions
• Impact of a single mistake is huge
• Scaling x100 means merchants must be
able to integrate with the docs only

User persona:  
developer
Frustrations: Outdated code samples,
difﬁculty ﬁnding what he’s looking for.
What makes Dave happy: As a developer,
Dave is used to working with and relying on
docs.
Good API documentation = happy Dave.
Questions: “Where can I ﬁnd typical
responses from APIs?”
Hi, I'm Dave
Should we integrate with Adyen?

Tech docs:
Automatic
generation
• Technical accuracy
• Consistency
• Up-to-date information
• Testing
• Flexible templating
• much more…

API standard: What to choose?
• Swagger (OpenAPI)
• RAML (MuleSoft)
• Blueprint (Apiary)
• …

Swagger: Pros
• Supported by Linux foundation
• Exists from 2010
• Steadily evolves
• RAML (Mulesoft) and Blueprint
(Apiary) recently joined OAS

Swagger vs OpenAPI
OpenAPI
Speciﬁcation
Swagger
Tools for implementing
the speciﬁcation

Swagger UI: Problems with nested structures

Demo:  
https://docs.adyen.com/api-explorer/

API Explorer: First wins
1. Support for multiple specs - more products and
versions
2. Groups and sorting for endpoints
3. Adaptive layout
4. Clean structure for nested objects
5. Multiple code examples
6. Rich JSON editor
7. Branded design

Let techwriters and
developers
collaborate on the
same content
This is a bench.

Always use the
latest version of
OpenAPI
• Callbacks
• Relationships between
operations
• Cookie parameters
• …

We need YOU!
• Visit https://docs.adyen.com/api-explorer/
and let us know what you think
• If you are working on a similar project,
contacts us
• We are hiring!

Thank you!
Questions?
wherever people pay

Presented by: Tom Wilson, hyper63 Presented at the All Things Open Virtual Meetup Abstract: APIs (Application Program Interfaces) is how programs can talk with other programs and is a design consideration for many products. Let’s discuss: Why you should build an application with an API? What are the top 5 requirements of designing an API with examples? Some open-source javascript frameworks that can help you design and build your API. In order to get the most out of this talk, you should have a good understanding of http REST protocol and general application development. Familiarity with javascript and technologies like NodeJS and Express would be a plus. In this talk, you should come away with a good understanding of why you should consider building an API in your application, key good practices every API should include, and how you could implement an API using Javascript.

apidays LIVE Hong Kong 2021 - Better API DX with a CLI by Phil Nash, Twilio

apidays

apidays LIVE London 2021 - API Security challenges and solutions by Wadii Tah...

apidays

APIs are the fundamental tenets of the Internet. They enable integrations between different services, and they power the servers that bring our applications to life. API integrations lay at the core of our API-driven world, and delivering successful API integrations is fundamental to sustain it. However, more often than not, API integrations tend to fail due to ineffective development workflows. In this presentation, I want to present various API development workflows that have helped me and my clients deliver successful API integrations. I’ll show how documentation-driven development, using mock servers, robust API testing frameworks, and API visibility tools can help to significantly reduce the chances of API integration failure and to keep errors under control.

apidays LIVE Hong Kong 2021 - GraphQL : Beyond APIs, graph your enterprise by...

apidays

apidays LIVE Hong Kong 2021 - Automating the API Product Lifecycle by Jeremy ...

apidays

Your API Strategy: Why Boring is Best

Nordic APIs

Put down your buzzword bingo cards. Martin Buhr, Creator and CEO of Tyk API Management Platform, is here to tell you why boring really is best when it comes to your API Strategy. In a tech world that’s brimming with modern technologies (each pushed as the next best thing to watching a couple argue in public), Martin makes his case for simple over sensational when it comes to managing your APIs. In his 20 minute polemic – ahem, we mean talk, he’ll make you embrace the mundane, savour the humdrum, and see beauty in the blah. With a tech talk that promises to throw a little history, pop culture, and, most likely, philosophy into the day’s API discussions, it will be nothing if not entertaining. So here’s to boring, but not being bored.

Pain Points In API Development? They’re Everywhere

Nordic APIs

There’s an inherent tension for organizations doing API development: how to keep both your API developers as well as your infrastructure happy, at the same time. Decoupling front-end and back-end development allows parallel development, and helps keep your front-end, middle-end, and back-end efforts working asynchronously. This speeds progress, but requires far more – and far better – collaboration to be successful. Even an independent developer working with APIs requires good collaboration tools. In this talk, Abhinav Asthana will provide tips on how to improve in API development using collaboration tools like executable API descriptions, API mock servers, and documentation. He will include specific examples of how companies (such as VMware, Coursera, and AMC Theatres) have used collaboration to attain more agile development, to onboard developers, and to ensure input from all participants/stakeholders.

APIdays Zurich 2019 - API management for event driven microservices, Fran Men...

apidays

Lessons Learned from Revamping Our Doc Site

Pronovix

API Management - Practical Enterprise Implementation Experience

Capgemini

Narinder Sahota Chief Architect - Capgemini David Rutter Solutions Architect - Capgemini APIs are something we take for granted as a key part of modern architecture. This session will talk through the practical experiences of implementing a new cloud-based API Management capability within a mature Enterprise with a complex and business critical integration estate. The session will cover what we learnt about the maturity and evolution of the API Management service implemented during the project, the team model that enabled success, the business benefits achieved, and how the platform is now evolving.

apidays LIVE London 2021 - Application to API Security, drivers to the Shift ...

apidays

apidays LIVE Paris 2021 - Addressing OWASP API Security Top 10 by Isabelle Ma...

apidays

Leaping Forward: Finding The Future of Your API Docs

Pronovix

Design-first API Development using Swagger and Node

Apigee | Google Cloud

apidays LIVE Hong Kong 2021 - Less Data is More by Damir Svrtan, Netflix

apidays

API First Workflow: How could we have better API Docs through DevOps pipeline

Pronovix

API Documentation plays an important role in improving the customer’s experience with APIs, which is always a struggle for most of the company. The way to accomplish this is to transition API development culture from “Code First” to “Design First”, here in SAS we call it “API First”. For better API designing and documentation, we have built an API First CI/CD workflow which brings many open-sourced API tools together and involves developers, product managers, documentation writers, and testers to synchronously work together to develop APIs in a “Design First” approach, the industry standard. In the talk, we will discuss how the API-first Workflow could enable better collaboration between teams which could help in many aspects especially writing the openAPI documentation, keeping it up to date and sync with your code. We will take a deep look at one example, the Linting tool from API First workflow, which helps to make sure the API documentation follows the company standard from the start. With openSource linting tools like Spectral, it’s easy for teams to define their own linting rules which includes company standards. When your API specifications go through the linter in the CI/CD pipeline, the linter will throw errors and warnings as you write your spec. This will help ensure your specification is following proper guidelines and that’s all automatic.

Building a REST API for Longevity

MuleSoft

One of the greatest challenges to developing an API is ensuring that your API lasts. After all, you don’t want to have to release and manage multiple versions of your API just because you weren’t expecting users to use it a certain way, or because you didn’t anticipate far enough down the roadmap. In this session, we’ll talk about the challenge of API Longevity, as well as ways to increase your API lifecycle including having a proper mindset, careful design, agile user experience and prototyping, best design practices including hypermedia, and the challenge of maintaining persistence.

API Design Workflows

Jakub Nesetril

What's hot

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

Apigee | Google Cloud

apidays LIVE Paris 2021 - APIGEE, different ways for integrating with CI/CD p...

apidays

I Love APIs 2015: Apigee and Node.js Building Mock Backends Fast

Apigee | Google Cloud

Essential Ingredients for a Successful API Program

Jason Harmon

apidays LIVE JAKARTA - How to build a community around your Open Source proje...

apidays

apidays LIVE London 2021 - Confessions of a Product Geek by Rosemary Missier,...

apidays

Pure APIs: Development workflows for successful API integrations

José Haro Peralta

apidays LIVE Hong Kong 2021 - GraphQL : Beyond APIs, graph your enterprise by...

apidays

apidays LIVE Hong Kong 2021 - Automating the API Product Lifecycle by Jeremy ...

apidays

Your API Strategy: Why Boring is Best

Nordic APIs

Pain Points In API Development? They’re Everywhere

Nordic APIs

APIdays Zurich 2019 - API management for event driven microservices, Fran Men...

apidays

Lessons Learned from Revamping Our Doc Site

Pronovix

API Management - Practical Enterprise Implementation Experience

Capgemini

apidays LIVE London 2021 - Application to API Security, drivers to the Shift ...

apidays

apidays LIVE Paris 2021 - Addressing OWASP API Security Top 10 by Isabelle Ma...

apidays

Leaping Forward: Finding The Future of Your API Docs

Pronovix

Design-first API Development using Swagger and Node

Apigee | Google Cloud

apidays LIVE Hong Kong 2021 - Less Data is More by Damir Svrtan, Netflix

apidays

API First Workflow: How could we have better API Docs through DevOps pipeline

Pronovix

What's hot (20)

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

apidays LIVE Paris 2021 - APIGEE, different ways for integrating with CI/CD p...

I Love APIs 2015: Apigee and Node.js Building Mock Backends Fast

Essential Ingredients for a Successful API Program

apidays LIVE JAKARTA - How to build a community around your Open Source proje...

apidays LIVE London 2021 - Confessions of a Product Geek by Rosemary Missier,...

Pure APIs: Development workflows for successful API integrations

apidays LIVE Hong Kong 2021 - GraphQL : Beyond APIs, graph your enterprise by...

apidays LIVE Hong Kong 2021 - Automating the API Product Lifecycle by Jeremy ...

Your API Strategy: Why Boring is Best

Pain Points In API Development? They’re Everywhere

APIdays Zurich 2019 - API management for event driven microservices, Fran Men...

Lessons Learned from Revamping Our Doc Site

API Management - Practical Enterprise Implementation Experience

apidays LIVE London 2021 - Application to API Security, drivers to the Shift ...

apidays LIVE Paris 2021 - Addressing OWASP API Security Top 10 by Isabelle Ma...

Leaping Forward: Finding The Future of Your API Docs

Design-first API Development using Swagger and Node

apidays LIVE Hong Kong 2021 - Less Data is More by Damir Svrtan, Netflix

API First Workflow: How could we have better API Docs through DevOps pipeline

Similar to Beyond the basic Swagger UI: Adyen API Explorer

Building a REST API for Longevity

MuleSoft

API Design Workflows

Jakub Nesetril

Building the Eventbrite API Ecosystem

Mitch Colleran

INTERFACE, by apidays - The 8 Key Components of a Modern API Stack by Iddo G...

apidays

SharePoint Fest Chicago - Introduction to AngularJS with the Microsoft Graph

Sébastien Levert

Every developer hears about AngularJS and all the magic it does for you applications. In order to kickstart you AngularJS journey, this session is an introduction to the AngularJS concepts applied to any Office 365 development. Different workloads will be targeted (Mail, Calendar, Files) and the Office 365 API will be our main datasource. We will also cover SharePoint Online specific data access (Office 365 API, REST, CSOM and Search) to meet your current development needs. The 3 key takeaways of this session are : You will understand the basics of the AngularJS framework You will learn how to communicate withthe Office 365 through AngularJS You will be able to apply those new skills in your next project

How to Design and Build a Great Web API

LaunchAny

apidays LIVE Paris 2021 - Lessons from the API Stewardship Journey in Azure b...

apidays

APIS for Startups - Running your Business Inside Out

3scale

Lessons learned on the Azure API Stewardship Journey.pptx

apidays

apidays LIVE Singapore 2022: Digitising at scale with APIs April 20 & 21, 2022 Lessons learned on the Azure API Stewardship Journey Adrian Hall, Principal Product Manager at Microsoft ------------ 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/ Deep dive into the API industry with our reports: https://www.apidays.global/industry-reports/ Subscribe to our global newsletter: https://apidays.typeform.com/to/i1MPEW

AWS User Group - Survey Results and Building APIs on AWS

Sebastian Krueger

APIs are the hot topic everyone talks about. Today, even CEO's appear to know what an API is. SOA is dead. Long live the API. This talk will give an overview of designing and implementing REST APIs in the context of AWS. We will cover the basics, but get pretty technical for most of the presentation. Followed by a deep dive of building a Survey API using API Gateway, Lambda, and DynamoDB (Surprised? ;-). Two architectural styles will be showcased. 1. Server-less design - API Gateway and Lambda 2. Server-based design - Elastic Beanstalk Live demo will be given using API Gateway and Lambda to design a basic API from scratch in only 15 minutes.

API Introduction - API Management Workshop Munich from Ronnie Mitra

CA API Management

Ronnie Mitra's slides from the Layer 7 Munich API Management Workshop. This workshop will included talks from Softcon CTO Michel Dorochevsky and Layer 7 API Architect Ronnie Mitra. The workshop Covered: • Discover the latest trends in the API economy • Understand why API Management is important • Learn best practices for securely exposing your APIs • Find out what other organizations are doing to manage their APIs

Accidental API developer - the 12 month pregnancy to create new API

Marjukka Niinioja

How to transfer from legacy system and legacy company to the brave new API world? Sharing some hands on experiences from 5 year journey in API development. “Rome wasn’t built in a day, nor should an API” so how should you prepare for the technological, organizational and business change: How do you change your sales, customer service and consultants to API sales, API customer service and API consultants? To solve or not to solve an integration problem with API? When UX problems changed to (API) service design problems?

APIs at Scale with TypeSpec by Mandy Whaley, Microsoft

Nordic APIs

A presentation given by Mandy Whaley, Partner Director of Product, Azure Developer Tools at Microsoft, at our 2024 Austin API Summit, March 12-13. Session Description: TypeSpec is a new API description language developed and used by Microsoft to deliver APIs at a massive scale. Learn how Microsoft uses TypeSpec to deliver high quality services to millions of customers and across tens of thousands of API endpoints. We will show how to use this new language and the related IDE tooling to encapsulate common API patterns into reusable components, up-level API descriptions with business-specific metadata and behaviors, connect API guidelines to development time activities, maintain API consistency, and generate custom assets, all while interoperating with the OpenAPI ecosystem.

Chris Mathias Presents Advanced API Design Considerations at LA CTO Forum

Chris Mathias

DevOps Friendly Doc Publishing for APIs & Microservices

Sonatype

Mandy Whaley, CISCO Microservices create an explosion of internal and external APIs. These APIs need great docs. Many organizations end up with a jungle of wiki pages, swagger docs and api consoles, and maybe just a few secret documents trapped in chat room somewhere… Keeping docs updated and in sync with code can be a challenge. We’ve been working on a project at Cisco DevNet to help solve this problem for engineering teams across Cisco. The goal is to create a forward looking developer and API doc publishing pipeline that: Has a developer friendly editing flow Accepts many API spec formats (Swagger, RAML, etc) Supports long form documentation in markdown Is CI/CD pipeline friendly so that code and docs stay in sync Flexible enough to be used by a wide scope of teams and technologies We have many interesting lessons learned about tooling and how to solve documentation challenges for internal and external facing APIs. We have found that solving this doc publishing flow is a key component of a building modern infrastructure. This is most definitely a culture + tech + ops + dev story, we look forward to sharing with the DevOps Days community.

API Description Languages

Akana

Just a few years back, lack of a standard way to document, govern or describe a contract for the APIs acted as a deterrent to API adoption within the enterprise. WSDL 2.0 and WADL provided early support, but they couldn’t truly capture the essence of RESTful APIs. Recently we have seen the emergence of several description languages. New ways to describe and document APIs have emerged such as Swagger, RAML, API Blueprint and others, each taking a slightly different approach.

API Description LanguagesAkana

Get Your Node.js API Swaggering with OpenAPI Spec

Adam Paxton

Application Insights for Integration Developers

Sriram Hariharan

How well does your solution work?, How do you know how well your solution works? In this session, Mike will show you how developers of integration solutions can use Azure Application Insights to complement existing monitoring solutions to provide developers with an additional level of insight into the way their solutions behave in the real world and how this can be applied to the types of integration components which we normally build.

Nascenia: Road to Software Industry

Nascenia IT

Similar to Beyond the basic Swagger UI: Adyen API Explorer (20)

Building a REST API for Longevity

API Design Workflows

Building the Eventbrite API Ecosystem

INTERFACE, by apidays - The 8 Key Components of a Modern API Stack by Iddo G...

SharePoint Fest Chicago - Introduction to AngularJS with the Microsoft Graph

How to Design and Build a Great Web API

apidays LIVE Paris 2021 - Lessons from the API Stewardship Journey in Azure b...

APIS for Startups - Running your Business Inside Out

Lessons learned on the Azure API Stewardship Journey.pptx

AWS User Group - Survey Results and Building APIs on AWS

API Introduction - API Management Workshop Munich from Ronnie Mitra

Accidental API developer - the 12 month pregnancy to create new API

APIs at Scale with TypeSpec by Mandy Whaley, Microsoft

Chris Mathias Presents Advanced API Design Considerations at LA CTO Forum

DevOps Friendly Doc Publishing for APIs & Microservices

API Description Languages

Get Your Node.js API Swaggering with OpenAPI Spec

Application Insights for Integration Developers

Nascenia: Road to Software Industry

Recently uploaded

GDG Cloud Southlake #33: Boule & Rebala: Effective AppSec in SDLC using Deplo...

James Anderson

Effective Application Security in Software Delivery lifecycle using Deployment Firewall and DBOM The modern software delivery process (or the CI/CD process) includes many tools, distributed teams, open-source code, and cloud platforms. Constant focus on speed to release software to market, along with the traditional slow and manual security checks has caused gaps in continuous security as an important piece in the software supply chain. Today organizations feel more susceptible to external and internal cyber threats due to the vast attack surface in their applications supply chain and the lack of end-to-end governance and risk management. The software team must secure its software delivery process to avoid vulnerability and security breaches. This needs to be achieved with existing tool chains and without extensive rework of the delivery processes. This talk will present strategies and techniques for providing visibility into the true risk of the existing vulnerabilities, preventing the introduction of security issues in the software, resolving vulnerabilities in production environments quickly, and capturing the deployment bill of materials (DBOM). Speakers: Bob Boule Robert Boule is a technology enthusiast with PASSION for technology and making things work along with a knack for helping others understand how things work. He comes with around 20 years of solution engineering experience in application security, software continuous delivery, and SaaS platforms. He is known for his dynamic presentations in CI/CD and application security integrated in software delivery lifecycle. Gopinath Rebala Gopinath Rebala is the CTO of OpsMx, where he has overall responsibility for the machine learning and data processing architectures for Secure Software Delivery. Gopi also has a strong connection with our customers, leading design and architecture for strategic implementations. Gopi is a frequent speaker and well-known leader in continuous delivery and integrating security into software delivery.

UiPath Test Automation using UiPath Test Suite series, part 4

DianaGray10

Welcome to UiPath Test Automation using UiPath Test Suite series part 4. In this session, we will cover Test Manager overview along with SAP heatmap. The UiPath Test Manager overview with SAP heatmap webinar offers a concise yet comprehensive exploration of the role of a Test Manager within SAP environments, coupled with the utilization of heatmaps for effective testing strategies. Participants will gain insights into the responsibilities, challenges, and best practices associated with test management in SAP projects. Additionally, the webinar delves into the significance of heatmaps as a visual aid for identifying testing priorities, areas of risk, and resource allocation within SAP landscapes. Through this session, attendees can expect to enhance their understanding of test management principles while learning practical approaches to optimize testing processes in SAP environments using heatmap visualization techniques What will you get from this session? 1. Insights into SAP testing best practices 2. Heatmap utilization for testing 3. Optimization of testing processes 4. Demo Topics covered: Execution from the test manager Orchestrator execution result Defect reporting SAP heatmap example with demo Speaker: Deepak Rai, Automation Practice Lead, Boundaryless Group and UiPath MVP

Quantum Computing: Current Landscape and the Future Role of APIs

Vlad Stirbu

Assuring Contact Center Experiences for Your Customers With ThousandEyes

ThousandEyes

Introduction to CHERI technology - Cybersecurity

mikeeftimakis1

Generative AI Deep Dive: Advancing from Proof of Concept to Production

Aggregage

FIDO Alliance Osaka Seminar: Overview.pdf

FIDO Alliance

Accelerate your Kubernetes clusters with Varnish Caching

Thijs Feryn

Smart TV Buyer Insights Survey 2024 by 91mobiles.pdf

91mobiles

Elevating Tactical DDD Patterns Through Object Calisthenics

Dorra BARTAGUIZ

After immersing yourself in the blue book and its red counterpart, attending DDD-focused conferences, and applying tactical patterns, you're left with a crucial question: How do I ensure my design is effective? Tactical patterns within Domain-Driven Design (DDD) serve as guiding principles for creating clear and manageable domain models. However, achieving success with these patterns requires additional guidance. Interestingly, we've observed that a set of constraints initially designed for training purposes remarkably aligns with effective pattern implementation, offering a more ‘mechanical’ approach. Let's explore together how Object Calisthenics can elevate the design of your tactical DDD patterns, offering concrete help for those venturing into DDD for the first time!

GenAISummit 2024 May 28 Sri Ambati Keynote: AGI Belongs to The Community in O...

Sri Ambati

Secstrike : Reverse Engineering & Pwnable tools for CTF.pptx

nkrafacyberclub

Monitoring Java Application Security with JDK Tools and JFR Events

Ana-Maria Mihalceanu

Le nuove frontiere dell'AI nell'RPA con UiPath Autopilot™

UiPathCommunity

In questo evento online gratuito, organizzato dalla Community Italiana di UiPath, potrai esplorare le nuove funzionalità di Autopilot, il tool che integra l'Intelligenza Artificiale nei processi di sviluppo e utilizzo delle Automazioni. 📕 Vedremo insieme alcuni esempi dell'utilizzo di Autopilot in diversi tool della Suite UiPath: Autopilot per Studio Web Autopilot per Studio Autopilot per Apps Clipboard AI GenAI applicata alla Document Understanding 👨‍🏫👨‍💻 Speakers: Stefano Negro, UiPath MVPx3, RPA Tech Lead @ BSP Consultant Flavio Martinelli, UiPath MVP 2023, Technical Account Manager @UiPath Andrei Tasca, RPA Solutions Team Lead @NTT Data

Empowering NextGen Mobility via Large Action Model Infrastructure (LAMI): pav...

Thierry Lestable

By Design, not by Accident - Agile Venture Bolzano 2024

Pierluigi Pugliese

How world-class product teams are winning in the AI era by CEO and Founder, P...

Product School

FIDO Alliance Osaka Seminar: Passkeys and the Road Ahead.pdf

FIDO Alliance

When stars align: studies in data quality, knowledge graphs, and machine lear...

Elena Simperl

Transcript: Selling digital books in 2024: Insights from industry leaders - T...

BookNet Canada

The publishing industry has been selling digital audiobooks and ebooks for over a decade and has found its groove. What’s changed? What has stayed the same? Where do we go from here? Join a group of leading sales peers from across the industry for a conversation about the lessons learned since the popularization of digital books, best practices, digital book supply chain management, and more. Link to video recording: https://bnctechforum.ca/sessions/selling-digital-books-in-2024-insights-from-industry-leaders/ Presented by BookNet Canada on May 28, 2024, with support from the Department of Canadian Heritage.

Recently uploaded (20)

GDG Cloud Southlake #33: Boule & Rebala: Effective AppSec in SDLC using Deplo...

UiPath Test Automation using UiPath Test Suite series, part 4

Quantum Computing: Current Landscape and the Future Role of APIs

Assuring Contact Center Experiences for Your Customers With ThousandEyes

Introduction to CHERI technology - Cybersecurity

Generative AI Deep Dive: Advancing from Proof of Concept to Production

FIDO Alliance Osaka Seminar: Overview.pdf

Accelerate your Kubernetes clusters with Varnish Caching

Smart TV Buyer Insights Survey 2024 by 91mobiles.pdf

Elevating Tactical DDD Patterns Through Object Calisthenics

GenAISummit 2024 May 28 Sri Ambati Keynote: AGI Belongs to The Community in O...

Secstrike : Reverse Engineering & Pwnable tools for CTF.pptx

Monitoring Java Application Security with JDK Tools and JFR Events

Le nuove frontiere dell'AI nell'RPA con UiPath Autopilot™

Empowering NextGen Mobility via Large Action Model Infrastructure (LAMI): pav...

By Design, not by Accident - Agile Venture Bolzano 2024

How world-class product teams are winning in the AI era by CEO and Founder, P...

FIDO Alliance Osaka Seminar: Passkeys and the Road Ahead.pdf

When stars align: studies in data quality, knowledge graphs, and machine lear...

Transcript: Selling digital books in 2024: Insights from industry leaders - T...

Beyond the basic Swagger UI: Adyen API Explorer

1. Adyen API Explorer Beyond the basic Swagger UI wherever people payAleksei Akimov

2. Adyen accepts payments over any sales channel

3. Adyen: 250+ payment methods China Netherlands France UKBelgium World Canada US Mexico Portugal Europe Russia Sweden South Korea Austria Poland Malaysia Japan Philippines Indonesia Australia Thailand Denmark Germany Finland Brasil

5. 2008 2010 2012 2014 2016 Annual processing: over $100B 2017

6. Docs: Main challenges • Release cycle: 3-4 weeks • 10+ APIs, different versions • Impact of a single mistake is huge • Scaling x100 means merchants must be able to integrate with the docs only

7. User persona:   developer Frustrations: Outdated code samples, difficulty finding what he’s looking for. What makes Dave happy: As a developer, Dave is used to working with and relying on docs. Good API documentation = happy Dave. Questions: “Where can I find typical responses from APIs?” Hi, I'm Dave Should we integrate with Adyen?

8. Tech docs: Automatic generation • Technical accuracy • Consistency • Up-to-date information • Testing • Flexible templating • much more…

9. From API  to documentation

10. API standard: What to choose? • Swagger (OpenAPI) • RAML (MuleSoft) • Blueprint (Apiary) • …

11. Swagger: Linux foundation

12. Swagger: Pros • Supported by Linux foundation • Exists from 2010 • Steadily evolves • RAML (Mulesoft) and Blueprint (Apiary) recently joined OAS

13. Swagger vs OpenAPI OpenAPI Speciﬁcation Swagger Tools for implementing the speciﬁcation

14. Format: OpenAPI Speciﬁcation

15. Format: API ﬁrst

16. From speciﬁcation to documentation

17. Swagger UI: Only for simple APIs

18. Swagger UI: Ineffective layout

19. Swagger UI: Problems with nested structures

20. How can we go beyond?

21. Dave   Learning Dave   Coding

22. Adyen: We work in streams

23.

24. Demo:   https://docs.adyen.com/api-explorer/

25. API Explorer: First wins 1. Support for multiple specs - more products and versions 2. Groups and sorting for endpoints 3. Adaptive layout 4. Clean structure for nested objects 5. Multiple code examples 6. Rich JSON editor 7. Branded design

26. Tips & Tricks

27. Let techwriters and developers collaborate on the same content This is a bench.

28. Always use the latest version of OpenAPI • Callbacks • Relationships between operations • Cookie parameters • …

29. Use markdown

30. Integrate Swagger in CI

31. OpenAPI supports custom annotations ;-)

32. Launch fast and iterate

33. We need YOU! • Visit https://docs.adyen.com/api-explorer/ and let us know what you think • If you are working on a similar project, contacts us • We are hiring!

34. Thank you! Questions? wherever people pay

Beyond the basic Swagger UI: Adyen API Explorer

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Similar to Beyond the basic Swagger UI: Adyen API Explorer

Similar to Beyond the basic Swagger UI: Adyen API Explorer (20)

Recently uploaded

Recently uploaded (20)

Beyond the basic Swagger UI: Adyen API Explorer