API Design Methodology - Mike Amundsen, Director of API Architecture, API Academy @ APIdays Sydney

•

20 likes•5,179 views

At some point, we all need to design and implement APIs for the Web. What makes Web APIs different than typical component APIs? How can you leverage the power of the Internet when creating your Web API? What characteristics to many "great" Web APIs share? Is there a consistent process you can use to make sure you design a Web API that best fits your needs both now and in the future? In this session Mike Amundsen describes a clear methodology for designing Web APIs (based on the book "RESTful Web APIs" by Richardson and Amundsen) that allows you to map key aspects of your business into a usable, scalable, and flexible interface that will reach your goals while creating a compelling API for both server and client developers. Whether you are looking to implement a private, partner, or public API, these principles will help you focus on the right metrics and design goals to create a successful API.

Technology

API Design Methodology
Mike Amundsen,
CA / Layer7
@mamund

Actually, we have a
methodology already...

Design Guidelines
● Craft [good/pretty/usable/stable] URIs

Design Guidelines
● Craft [good/pretty/usable/stable] URIs
● Map domain actions to HTTP methods (CRUD)

Design Guidelines
● Craft [good/pretty/usable/stable] URIs
● Map domain actions to HTTP methods (CRUD)
● Use the proper HTTP Status Codes

Design Guidelines
● Craft [good/pretty/usable/stable] URIs
● Map domain actions to HTTP methods (CRUD)
● Use the proper HTTP Status Codes
● Document serialized objects as HTTP bodies

Ok, so what is a design
methodology, then?

1. List the Semantic Descriptors
(the what?)

1. List the Semantic Descriptors
(the what?)
You know, the stuff!

1. List the Semantic Descriptors
● A maze
● A maze cell
● A switch
● Switch position ("up" or "down")
● The title of a maze cell
● A doorway connecting to cells
● An exit from the maze
● A list of mazes

3. Reconcile Names
● IANA Link Relation Values
● schema.org
● microformats
● Dublin Core
● Activity Streams

3. Reconcile Names
● maze
● start
● current
● exit
● north, south, east, west
● switch
● flip

3. Reconcile Names
● maze
● start (IANA)
● current (IANA)
● exit
● north, south, east, west
● switch
● flip

3. Reconcile Names
● maze
● start (IANA)
● current (IANA)
● exit (microformats)
● north, south, east, west (microformats)
● switch
● flip

3. Reconcile Names
● maze
● start (IANA)
● current (IANA)
● exit (microformats)
● north, south, east, west (microformats)
● switch
● flip edit (IANA)

3. Reconcile Names
● http://mamund.com/rels/maze (RFC5988)
● start (IANA)
● current (IANA)
● exit (microformats)
● north, south, east, west (microformats)
● http://mamund.com.rels/switch (RFC5988)
● flip edit (IANA)

3. Reconcile Names
● IANA
o edit
o start
o current
● microformats
o exit
o north, south, east, west
● RFC5988
o http://mamund.com/rels/switch
o http://mamund.com/rels/maze

But I still need to implement it,
right?

4. Choose a Media Type
● Use application/json, application/xml
● Collection type: Atom, OData, Collection+JSON
● Free-form: HTML, Siren, HAL, JSON-LD
● Invent your own semantic type

Don't start with the
representation format

Standard names are probably better
than yours.

Don't keep all the hypermedia
in one place

Some Final Advice
● Resources are implementation details
● Don't fall into the collection trap
● Don't start w/ the representation format
● URL design doesn't matter
● Standard names are probably better than
yours
● Don't keep all the hypermedia in one place

In Conclusion...
● Don't confuse implementation w/ design
● Design is the hard part (high value)
● Implementation is the easy part (high speed)
● Avoid common design mistakes
● Go out and make lots of APIs!

What's hot

gRPC Overview

Varun Talwar

Introduction to Microservices Architecture, Docker, Kubernetes, Istio, Testing Strategies for Microservices based Apps. Security Best Practices. Kanban, DevOps, and SRE. Infrastructure Design Patterns - API Gateway - Service Discovery - Load Balancer - Circuit Breaker - Let-it-Crash Pattern Software Design Patterns - Hexagonal Architecture - Domain Driven Design - Event Sourcing and CQRS - Functional Reactive Programming

Microservices Docker Kubernetes Istio Kanban DevOps SRE

Araf Karsh Hamid

Deployment Patterns in WSO2 Enterprise Integrator

WSO2

The Patterns of Distributed Logging and Containers

SATOSHI TAGOMORI

Google Cloud and Data Pipeline Patterns

Lynn Langit

Event Sourcing & CQRS, Kafka, Rabbit MQ

Araf Karsh Hamid

The basics of fluentd

Treasure Data, Inc.

Presentation at NetPonto community: "We’re going to discuss gRPC, Google’s open-source RPC framework. I’ll dive a bit into the history of RPC as a protocol, and what its historical use has been. I’ll also highlight some benefits to adopt gRPC and how its possible to swap out parts of gRPC and still take advantage of gRPC’s benefits. Finally I’ll answer the question that has been on many lips since gRPC was announced — what does this mean for REST?"

gRPC - RPC rebirth?

Luís Barbosa

D2 domain driven-design

Arnaud Bouchez

Intro to open source observability with grafana, prometheus, loki, and tempo(...

LibbySchulze

Spring Native and Spring AOT

VMware Tanzu

High Performance Systems in Go - GopherCon 2014

Derek Collison

Kafka + Uber- The World’s Realtime Transit Infrastructure, Aaron Schildkrout

confluent

Understand the Microservices Architecture concepts Understand Event Sourcing and CQRS Understanding Domain Driven Design Understanding Functional Reactive Programming Understanding Distributed Transaction Management Understanding Microservices Messaging Setting up Micro services Infrastructure (API Gateway, Service Discovery, Load Balancer, Circuit Breaker) https://github.com/meta-magic/microservice_workshop

Microservices Architecture Part 2 Event Sourcing and Saga

Araf Karsh Hamid

gRPC and Microservices

Jonathan Gomez

Most of us will be familiar with the standard 3- or 4-layer architecture you often see in larger enterprise systems. Some are already practicing Domain Driven Design and work together with the business to clarify the domain concepts. Perhaps you’ve noticed that is difficult to get the intention of the 'verbs' from that domain into this standard architecture. If performance is an important requirement as well, then you might have discovered that an Object-Relational Mapper and a relational database are not always the best solution. One of the main reasons for this is the fact that the interests of a consistent domain that takes into account the many business rules, and those of data reporting and presentation are conflicting. That’s why Betrand Meyer introduced the Command Query Separation principle. An architecture based on this principle combined with the Event Sourcing concept provides the ideal architecture for building high-performance systems designed using DDD. Well-known bloggers like Udi Dahan and Greg Young have already spent quite a lot of of posts on this, and this year’s Developer Days had some coverage as well. But how do you build such a system with the. NET framework? Is it really as complex as some claim, or is just different work?

CQRS and Event Sourcing, An Alternative Architecture for DDD

Dennis Doomen

Spend some time working with OpenAPI and gRPC and you’ll notice that these two technologies have a lot in common. Both are open source efforts, both describe APIs, and both promise better experiences for API producers and consumers. So why do we need both? If we do, what value does each provide? What can each project learn from the other? We’ll bring the two together for a side-by-side comparison and pose answers to these and other questions about two API methodologies that will do much to influence the future of networked APIs.

OpenAPI and gRPC Side by-Side

Tim Burks

The right architecture is key for any IT project. This is especially the case for big data projects, where there are no standard architectures which have proven their suitability over years. This session discusses the different Big Data Architectures which have evolved over time, including traditional Big Data Architecture, Streaming Analytics architecture as well as Lambda and Kappa architecture and presents the mapping of components from both Open Source as well as the Oracle stack onto these architectures.

Big Data Architecture

Guido Schmutz

This is part 1 of my Kubernetes architecture deep-dive slide series. I have been working with Kubernetes for more than a year, from v1.3.6 to v1.6.7, and I am a CNCF certified Kubernetes administrator. Before I move on to something else, I would like to summarize and share my knowledges and take-aways about Kubernetes, from a software engineer perspective. This set of slides is a humble dig into one level below your running application in production, revealing how different components of Kubernetes work together to orchestrate containers and present your applications to the rest of the world. The slides contains 80+ external links to Kubernetes documentations, blog posts, Github issues, discussions, design proposals, pull requests, papers, source code files I went through when I was working with Kubernetes - which I think are valuable for people to understand how Kubernetes works, Kubernetes design philosophies and why these design came into places.

Kubernetes Architecture - beyond a black box - Part 1

Hao H. Zhang

From airflow to google cloud composer

Bruce Kuo

What's hot (20)

gRPC Overview

Microservices Docker Kubernetes Istio Kanban DevOps SRE

Deployment Patterns in WSO2 Enterprise Integrator

The Patterns of Distributed Logging and Containers

Google Cloud and Data Pipeline Patterns

Event Sourcing & CQRS, Kafka, Rabbit MQ

The basics of fluentd

gRPC - RPC rebirth?

D2 domain driven-design

Intro to open source observability with grafana, prometheus, loki, and tempo(...

Spring Native and Spring AOT

High Performance Systems in Go - GopherCon 2014

Kafka + Uber- The World’s Realtime Transit Infrastructure, Aaron Schildkrout

Microservices Architecture Part 2 Event Sourcing and Saga

gRPC and Microservices

CQRS and Event Sourcing, An Alternative Architecture for DDD

OpenAPI and gRPC Side by-Side

Big Data Architecture

Kubernetes Architecture - beyond a black box - Part 1

From airflow to google cloud composer

Viewers also liked

Domain Driven Design Through Onion Architecture

BoldRadius Solutions

Applying Domain-Driven Design to APIs and Microservices - Austin API Meetup

LaunchAny

Domain Driven Design

Nikolay Vasilev

Onion Architecture

matthidinger

The Architecture of an API Platform

Johannes Ridderstedt

Extend your legacy SOA/ESB infrastructure to Mobile & IoT This webinar recording provides a use-case driven discussion around appropriate use of existing middleware infrastructure as well as its shortcomings. It dives deep into how APIs can not only complement an ESB or SOA infrastructure but also fill existing gaps. Watch this webinar recording to learn about: - Strengths and weaknesses of your existing ESB/SOA infrastructure - Architecture strategy: extend and add value to legacy middleware with APIs - Integration / API use cases in Retail, Manufacturing and Telecom - The API360 approach to digital strategy

Api architectures for the modern enterprise

CA API Management

In building large scale web applications MVC seems like a good solution in the initial design phase. However after having built a few large apps that have multiple entry points (web, cli, api etc) you start to find that MVC breaks down. Start using Domain Driven Design. Domain-driven design (DDD) is an approach to software development for complex needs by connecting the implementation to an evolving model.[1] The premise of domain-driven design is the following: Placing the project's primary focus on the core domain and domain logic. Basing complex designs on a model of the domain. Initiating a creative collaboration between technical and domain experts to iteratively refine a conceptual model that addresses particular domain problems. Have more questions? Twitter: @wajrcs Web: http://waqaralamgir.tk

Domain Driven Design using Laravel

wajrcs

Designing APIs and Microservices Using Domain-Driven Design

LaunchAny

Software Design Patterns in Laravel by Phill Sparks

Phill Sparks

Viewers also liked (9)

Domain Driven Design Through Onion Architecture

Applying Domain-Driven Design to APIs and Microservices - Austin API Meetup

Domain Driven Design

Onion Architecture

The Architecture of an API Platform

Api architectures for the modern enterprise

Domain Driven Design using Laravel

Designing APIs and Microservices Using Domain-Driven Design

Software Design Patterns in Laravel by Phill Sparks

Similar to API Design Methodology - Mike Amundsen, Director of API Architecture, API Academy @ APIdays Sydney

01 html-introduction

Mohsin Mushtaq

AngularJS, together with Node.js, is an extremely powerful combination for building single page applications. Unfortunately, its development requires writing HTML and Javascript, which is tedious and error prone. By using vibe.d, HTML is no longer necessary, and the developers can use the full power of a static-typed language for the development of the backend. Substituting Javascript with Typescript in addition to a little bit of CTFE D magic then removes the need for redundant data type declarations, and makes everything statically typed. At the end of the talk, the attendee will have witnessed the creation of a statically typed, asynchronous single page application that required little extra typing than its dynamically typed equivalent. Additionally, the attendees will be motivated to explore the presented combination of frameworks as a viable desktop application UI framework.

Asynchronous single page applications without a line of HTML or Javascript, o...

Robert Schadek

Dust.js

Yevgeniy Brikman

Web development basics (Part-3)

Rajat Pratap Singh

Your First Scala Web Application using Play 2.1

Matthew Barlocker

Performance (browser)

aquarius070287

Dart the Better JavaScript

Jorg Janke

Document Object Model

chomas kandar

Document Object Model

chomas kandar

RoR 101: Session 1

Rory Gianni

Getting Started with Rails

Basayel Said

Scraping the web with Laravel, Dusk, Docker, and PHP

Paul Redmond

Node.js streams talk

zladuric

Intro to web scraping with Python

Maris Lemba

Sooner or later we all have to work with HTML, despite its verbosity. Those of us who claim to love HTML may just be victims of Stockholm Syndrome, both praising yet secretly loathing it. Basho designer John Newman is making the trek from the swamps of Florida to show us the way. In the modern world of markup preprocessors, these alternative syntaxes allow you to write simpler, cleaner, more concise code in a shorter amount of time. Certain techniques can even allow your team members who may be less-tech-savvy to contribute content directly without forcing you to wire up a WYSIWYG style CMS. This talk explores great alternatives to plain HTML and CSS, and covers how Basho put these tools together to facilitate a painless, team-oriented approach to building sites and web apps.

Killing the Angle Bracket

jnewmanux

django

webuploader

Python ScrapingPresentation for dummy.pptx

norel46453

Microservices in Scala: Spray

Łukasz Sowa

Scio - A Scala API for Google Cloud Dataflow & Apache Beam

Neville Li

Sinatra and JSONQuery Web Service

vvatikiotis

Similar to API Design Methodology - Mike Amundsen, Director of API Architecture, API Academy @ APIdays Sydney (20)

01 html-introduction

Asynchronous single page applications without a line of HTML or Javascript, o...

Dust.js

Web development basics (Part-3)

Your First Scala Web Application using Play 2.1

Performance (browser)

Dart the Better JavaScript

Document Object Model

RoR 101: Session 1

Getting Started with Rails

Scraping the web with Laravel, Dusk, Docker, and PHP

Node.js streams talk

Intro to web scraping with Python

Killing the Angle Bracket

django

Python ScrapingPresentation for dummy.pptx

Microservices in Scala: Spray

Scio - A Scala API for Google Cloud Dataflow & Apache Beam

Sinatra and JSONQuery Web Service

More from CA API Management

Mastering Digital Channels with APIs

CA API Management

Examining today's biggest API breaches to mitigate API security vulnerabilities Data breaches have become the top news story. And APIs are quickly becoming the hacker's new favorite attack vector. They offer a direct path to critical information and business services that can be easily stolen or disrupted. And your private APIs can be exploited just as easily as a public API. So what measures can you take to strengthen your security position? This webinar explores recent API data breaches, the top API security vulnerabilities that are most impactful to today's enterprise and the protective measures that need to be taken to mitigate API and business exposure. You Will Learn -Recent breaches in the news involving APIs -Top attacks that compromise your business -Mitigating steps to protect your business from attacks and unauthorized access -API Management solutions that both enable and protect your business Learn about API Security at http://www.ca.com/api

Takeaways from API Security Breaches Webinar

CA API Management

Liberating the API Economy with Scale-Free Networks The Web exhibits a feature found in many complex systems known as "Scale-Free" or "Power-Law" networks, sometimes called the "long tail" Most people think of the "long tail" as an economic and/or social property. However, it also represents physical and informational properties fundamental to the way the Web works. But the steady increase in major service outages indicate that many current Web APIs, services, and even client applications ignore this basic "law of the Web." This talk explores the "Scale-Free" rule of complex systems and offers clear and simple advice to those planning to build and/or consume APIs for the Web. Such as what to avoid, what to plan for, what to build, and how to identify & steer clear of clients and services that fail to abide by the rules and, in the process, are making it harder for all of us to liberate the API Economy.

Liberating the API Economy with Scale-Free Networks - Mike Amundsen, Director...

CA API Management

APIs are everywhere: powering mobile apps, enabling cloud computing, connecting people through social networks and helping to create the Internet of Things. Organizations of every kind are evaluating how they can leverage APIs and replicate the success of companies like Amazon, Google and Salesforce. Join this webinar to learn about the #API360 model for enterprise API success. This model covers the full spectrum of considerations for companies looking to succeed with APIs for the long haul. You will also hear more about the upcoming #API360 Summit that will take place in Dallas on February 26. You Will Learn • How leading Web companies have used APIs to boost revenues and market share • How to create an enterprise API strategy that will yield real business results • How to institutionalize best practices that will allow your APIs to evolve and grow

API360 – A How-To Guide for Enterprise APIs - Learn how to position your ente...

CA API Management

Securely Open data as APIs to internal groups and third parties to generate revenue In today's application economy, organizations are leveraging APIs to create new revenue streams. To monetize its information, the enterprise needs a way to transform data into APIs, enforce SLAs and implement a standardized fulfillment process with flexible and integrated billing systems. This webinar will explored how enterprises can overcome these monetization challenges, using an API management solution that securely opens data to internal groups and third parties as APIs, in order to generate revenue.

API Monetization: Unlock the Value of Your Data

CA API Management

The Information Age, 100 years on The rise of the computer and the digital revolution is responsible for an explosion of devices, data, and connectedness. These are all enabling what is called the dawning of the Information Age. And software designers, developers, and architects all share an important responsibility for shaping and guiding the world’s progress through this axial age into the future. However, more than 100 years ago, the work of organizing the world’s information into a single all-encompassing taxonomy had already begun. Partially influenced by the positivist doctrine of Auguste Comte, leading thinkers of the early 20th century such as the librarian Paul Otlet in Belgium, museum curator Patrick Geddes in Scotland, and educator Melvil Dewey in the US were each working to design universal classification systems that would encompass and coordinate the explosion of information appearing in libraries, museums, newspapers, magazines, and eventually even radio, movies, and television. What did we learn in the last century? What have we forgotten? How does their work affect our current trajectory in transforming the work of software and systems design and development? What can we take from Dewey, Otlet, and Geddes with us in to the next 100 years of the Information Age.

Revisiting Geddes' Outlook Tower - Mike Amundsen, Director of API Architectur...

CA API Management

Identity on the Internet is changing. Social networking has kicked off a massive change in how we integrate identity across applications. This is much more than a simple redesign of security tokens and protocols; instead it is a radical redistribution of power and control over entitlements, shifting it away from the centralized control of a cabal of directory engineers and out to the users themselves. There are compelling reasons for this shift: it enables scaling of identity administration, and it promotes rapid and agile integration of applications. These are goals shared by the enterprise, but this change has significant implications on infrastructure, people and process. Join us to learn how you can bring modern identity management into the enterprise.

Managing Identity by Giving Up Control - Scott Morrison, SVP & Distinguished ...

CA API Management

Moving beyond conventional single sign-on to seamless cross-device access with APIs People are carrying more devices every day – with the average being 2.9 per person. Meanwhile, multitasking has gone into overdrive, as users quickly move from laptop to phone to tablet, expecting a seamless experience when accessing their favorite apps. And this expectation is not just limited to leisure and personal use – it extends to business applications. Security has broken this seamless workflow and inhibited the mobile “stickiness” businesses are striving to achieve. This webinar with Scott Morrison and Leif Bildoy of CA Technologies will demonstrate how the right combination of identity functionality and secure APIs can help your organization to overcome these challenges and enable the multi-device universe. You Will Learn • What challenges must be overcome when supporting multiple mobile app types • How SSO is evolving past mobile app access to device access • Why the right implementation of identity and APIs will create consumer stickiness • How the Internet of Things (IoT) is creating new business opportunities

Enabling the Multi-Device Universe

CA API Management

Building APIs That Last for Decades - Irakli Nadareishvili, Director of API S...

CA API Management

The Art of API Design - Ronnie Mitra, Director of API Design, API Academy at ...

CA API Management

APIs Fueling the Connected Car Opportunity - Scott Morrison, SVP & Distinguis...

CA API Management

Adapting to Digital Change: Use APIs to Delight Customers & Win

CA API Management

Today’s enterprise mobility solutions emphasize heavy-handed IT governance of devices and applications that impose a burden on developers and/or users. However, managing data and applications using high performance mobile-optimized infrastructure can enable secure, scalable apps while minimizing the effort required by developers and allowing them to focus on their strengths. Come learn how to facilitate the best of both worlds – multi-layer mobile security using modern standards and a fantastic user experience.

Balancing Security & Developer Enablement in Enterprise Mobility - Jaime Ryan...

CA API Management

5 steps end to end security consumer apps

CA API Management

By now you’ve bought into the idea of using APIs to integrate cloud, mobile devices and the enterprise. But are building safe APIs? One insecure API can increase your organization’s risk profile exponentially. Securing APIs is not like securing the web—a point lost on many developers coming from a web-centric background. Learn what good practices to put in place and the common security anti-patterns you must avoid to ensure your company’s APIs are reliable, safe and secure. You will learn: • The top ways hackers exploit APIs in the wild • Common identity pitfalls and how to avoid them • Why OAuth scopes are essential to master • How to keep web developers from bringing bad habits with them

Best Practices You Must Apply to Secure Your APIs - Scott Morrison, SVP & Dis...

CA API Management

The Internet of Things (IoT) promises to improve our productivity and day-to-day lives by connecting a vast range of devices – from cell phones, to cars, to domestic appliances and even to drones. APIs represent the key technology that will make it possible to integrate and leverage information from all these “things”. There are obvious security and privacy concerns associated with using APIs to expose data and functionality from one device to many others. So, how can we make sure hackers cannot exploit the unprecedented connectivity created by IoT? This webinar will explore key IoT use cases and explain how to address the API security requirements for these use cases.

Drones, Phones & Pwns the Promise & Dangers of IoT APIs: Use APIs to Securely...

CA API Management

The VIP networking lunch will feature a presentation by Keith Junius, Solution Architect, from Veda on ‘Implementing an API Management Platform’. Attendees will hear about how Veda has modernized their B2B API platform by deploying SOA Gateways. Join Layer 7 at this lunch to learn about: • Design considerations for API management platforms • Technical and business challenges faced across the whole system lifecycle • The soft skills required to achieve a successful outcome • Lessons learned during and after the project • Benefits realized by the new platform

Gartner AADI Summit Sydney 2014 Implementing the Layer 7 API Management Pla...

CA API Management

Today, tech-savvy consumers are always connected, using their mobile devices to compare prices, read user-generated reviews and pay for products - and many leading e-tailers already connect their customers to this information. The any time, any place connectivity enabled by mobile devices empowers all retailers to offer the kinds of enhanced shopping experiences modern consumers are becoming accustomed to. To truly satisfy the needs of these well-informed, mobile consumers, retail organizations will need ways to create unified shopping experiences across all channels – from brick-and-mortar stores to the Web to mobile. Increasingly, offering a compelling mobile experience will become the cornerstone upon which these omni-channel shopping experiences are built. In this webinar, you will learn how APIs can: • Help deliver a consistent retail experience across multiple channels • Connect retailers with social data • Extend legacy systems to mobile apps • Enable organizations to make real-time use of contextual data and buying patterns

Using APIs to Create an Omni-Channel Retail Experience

CA API Management

Cars are already full of sensors and producing gigabytes of data, but they are not connected yet. Connecting them can represent a tremendous opportunity for several industries (insurance companies, repairs, traffic optimization...) but it certainly comes with a lot of challenges. Security and Privacy are the biggest challenges this market have to overcome, especially because it has been completely out of scope for this industry so far.

Panel Session: Security & Privacy for Connected Cars w/ Scott Morrison, SVP ...

CA API Management

As HTTP-based APIs become more common and more standardized, mindshare and momentum is shifting from a service-oriented model to the "client-side" of the application space. It is the client application that users fall in love with and it is the client application developer that holds the keys to this relationship. Client developers pick APIs based not just on ease of use and helpful document. Often they are selecting APIs that make their applications "look good" and APIs that can be easily "mashed up" with other service offerings into new "applications" - ones that don't rely on just one service API. This talk reviews patterns in developer practices and trends in services and libraries -- from the increase in the number of client-side libraries such as EmberJS, Angular, and Bootstrap to the appearance of new "API composition" platforms such as Strong Loop -- that give us a picture of why it's important to identify and leverage the growing sentiment that "Clients Matter, Services Don't.

Clients Matter, Services Don't - Mike Amundsen's talk from QCon New York 2014

CA API Management

More from CA API Management (20)

Mastering Digital Channels with APIs

Takeaways from API Security Breaches Webinar

Liberating the API Economy with Scale-Free Networks - Mike Amundsen, Director...

API360 – A How-To Guide for Enterprise APIs - Learn how to position your ente...

API Monetization: Unlock the Value of Your Data

Revisiting Geddes' Outlook Tower - Mike Amundsen, Director of API Architectur...

Managing Identity by Giving Up Control - Scott Morrison, SVP & Distinguished ...

Enabling the Multi-Device Universe

Building APIs That Last for Decades - Irakli Nadareishvili, Director of API S...

The Art of API Design - Ronnie Mitra, Director of API Design, API Academy at ...

APIs Fueling the Connected Car Opportunity - Scott Morrison, SVP & Distinguis...

Adapting to Digital Change: Use APIs to Delight Customers & Win

Balancing Security & Developer Enablement in Enterprise Mobility - Jaime Ryan...

5 steps end to end security consumer apps

Best Practices You Must Apply to Secure Your APIs - Scott Morrison, SVP & Dis...

Drones, Phones & Pwns the Promise & Dangers of IoT APIs: Use APIs to Securely...

Gartner AADI Summit Sydney 2014 Implementing the Layer 7 API Management Pla...

Using APIs to Create an Omni-Channel Retail Experience

Panel Session: Security & Privacy for Connected Cars w/ Scott Morrison, SVP ...

Clients Matter, Services Don't - Mike Amundsen's talk from QCon New York 2014

Recently uploaded

Whatsapp Number Escorts Call girls 8617370543 Available 24x7 Mcleodganj Call Girls Service Offer Genuine VIP Model Escorts Call Girls in Your Budget. Mcleodganj Call Girls Service Provide Real Call Girls Number. Make Your Sexual Pleasure Memorable with Our Mcleodganj Call Girls at Affordable Price. Top VIP Escorts Call Girls, High Profile Independent Escorts Call Girls, Housewife Women Escorts Call Girl, College Girls Escorts Call Girls, Russian Escorts Call girls Service in Your Budget.

Mcleodganj Call Girls 🥰 8617370543 Service Offer VIP Hot Model

Deepika Singh

Sidekick Solutions uses Bonterra Impact Management (fka Social Solutions Apricot) and automation solutions to integrate data for business workflows. We believe integration and automation are essential to user experience and the promise of efficient work through technology. Automation is the critical ingredient to realizing that full vision. We develop integration products and services for Bonterra Case Management software to support the deployment of automations for a variety of use cases. This video focuses on the deployment of external web forms using Jotform for Bonterra Impact Management. This solution can be customized to your organization’s needs and deployed to support the common use cases below: - Intake and consent - Assessments - Surveys - Applications - Program registration Interested in deploying web form automations for Bonterra Impact Management? Contact us at sales@sidekicksolutionsllc.com to discuss next steps.

Web Form Automation for Bonterra Impact Management (fka Social Solutions Apri...

Jeffrey Haguewood

MINDCTI Revenue Release Quarter One 2024

MIND CTI

presentation ICT roal in 21st century education

jfdjdjcjdnsjd

Passkeys: Developing APIs to enable passwordless authentication Cody Salas, Sr Developer Advocate | Solutions Architect - Yubico 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 - Passkeys: Developing APIs to enable passwordless auth...

apidays

CNIC Information System with Pakdata Cf In Pakistan

danishmna97

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

The value of a flexible API Management solution for Open Banking Steve Melan, Manager for IT Innovation and Architecture - State's and Saving's Bank of Luxembourg 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 - The value of a flexible API Management solution for O...

apidays

Discover the innovative features and strategic vision that keep WSO2 an industry leader. Explore the exciting 2024 roadmap of WSO2 API management, showcasing innovations, unified APIM/APK control plane, natural language API interaction, and cloud native agility. Discover how open source solutions, microservices architecture, and cloud native technologies unlock seamless API management in today's dynamic landscapes. Leave with a clear blueprint to revolutionize your API journey and achieve industry success!

WSO2's API Vision: Unifying Control, Empowering Developers

WSO2

Polkadot JAM Slides - Token2049 - By Dr. Gavin Wood

Juan lago vázquez

Architecting Cloud Native Applications

WSO2

MS Copilot expands with MS Graph connectors

Nanddeep Nachan

Strategies for Landing an Oracle DBA Job as a Fresher

Remote DBA Services

Accelerating FinTech Innovation: Unleashing API Economy and GenAI Vasa Krishnan, Chief Technology Officer - FinResults 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 - Accelerating FinTech Innovation by Vasa Krishnan, Fin...

apidays

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

💥 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

Angeliki Cooney has spent over twenty years at the forefront of the life sciences industry, working out of Wynantskill, NY. She is highly regarded for her dedication to advancing the development and accessibility of innovative treatments for chronic diseases, rare disorders, and cancer. Her professional journey has centered on strategic consulting for biopharmaceutical companies, facilitating digital transformation, enhancing omnichannel engagement, and refining strategic commercial practices. Angeliki's innovative contributions include pioneering several software-as-a-service (SaaS) products for the life sciences sector, earning her three patents. As the Senior Vice President of Life Sciences at Avenga, Angeliki orchestrated the firm's strategic entry into the U.S. market. Avenga, a renowned digital engineering and consulting firm, partners with significant entities in the pharmaceutical and biotechnology fields. Her leadership was instrumental in expanding Avenga's client base and establishing its presence in the competitive U.S. market.

Biography Of Angeliki Cooney | Senior Vice President Life Sciences | Albany, ...

Angeliki Cooney

Six Myths about Ontologies: The Basics of Formal Ontology

johnbeverley2021

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

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

Zilliz

Recently uploaded (20)

Mcleodganj Call Girls 🥰 8617370543 Service Offer VIP Hot Model

Web Form Automation for Bonterra Impact Management (fka Social Solutions Apri...

MINDCTI Revenue Release Quarter One 2024

presentation ICT roal in 21st century education

Apidays New York 2024 - Passkeys: Developing APIs to enable passwordless auth...

CNIC Information System with Pakdata Cf In Pakistan

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

Apidays New York 2024 - The value of a flexible API Management solution for O...

WSO2's API Vision: Unifying Control, Empowering Developers

Polkadot JAM Slides - Token2049 - By Dr. Gavin Wood

Architecting Cloud Native Applications

MS Copilot expands with MS Graph connectors

Strategies for Landing an Oracle DBA Job as a Fresher

Apidays New York 2024 - Accelerating FinTech Innovation by Vasa Krishnan, Fin...

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

DEV meet-up UiPath Document Understanding May 7 2024 Amsterdam

Biography Of Angeliki Cooney | Senior Vice President Life Sciences | Albany, ...

Six Myths about Ontologies: The Basics of Formal Ontology

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

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

API Design Methodology - Mike Amundsen, Director of API Architecture, API Academy @ APIdays Sydney

1. API Design Methodology Mike Amundsen, CA / Layer7 @mamund

2. Introduction

10.

11.

12. Actually, we have a methodology already...

13. Design Guidelines ● Craft [good/pretty/usable/stable] URIs

14.

15. Design Guidelines ● Craft [good/pretty/usable/stable] URIs ● Map domain actions to HTTP methods (CRUD)

16.

17. Design Guidelines ● Craft [good/pretty/usable/stable] URIs ● Map domain actions to HTTP methods (CRUD) ● Use the proper HTTP Status Codes

18.

19. Design Guidelines ● Craft [good/pretty/usable/stable] URIs ● Map domain actions to HTTP methods (CRUD) ● Use the proper HTTP Status Codes ● Document serialized objects as HTTP bodies

20.

21. Design Guidelines ● Craft [good/pretty/usable/stable] URIs ● Map domain actions to HTTP methods (CRUD) ● Use the proper HTTP Status Codes ● Document serialized objects as HTTP bodies ● Use HTTP headers responsibly

22.

23. Design Guidelines ● Craft [good/pretty/usable/stable] URIs ● Map domain actions to HTTP methods (CRUD) ● Use the proper HTTP Status Codes ● Document serialized objects as HTTP bodies ● Use HTTP headers responsibly ● Describe edge cases (async, errors, authN/Z)

24.

25.

26.

27.

28.

29. But there's a problem here...

30. Those are not design guidelines..

31. They are implementation guidelines!

32.

33. Ok, so what is a design methodology, then?

34.

35.

36. Here's a simple seven-step procedure...

37. Here's a simple seven-step procedure...

38. Let's design a Maze game API

39.

40. 1. List the Semantic Descriptors

41. 1. List the Semantic Descriptors (the what?)

42. 1. List the Semantic Descriptors (the what?) You know, the stuff!

43. 1. List the Semantic Descriptors ● A maze ● A maze cell ● A switch ● Switch position ("up" or "down") ● The title of a maze cell ● A doorway connecting to cells ● An exit from the maze ● A list of mazes

44.

45. 2. Draw a State Diagram

46.

47. 3. Reconcile Names

48. 3. Reconcile Names ● IANA Link Relation Values ● schema.org ● microformats ● Dublin Core ● Activity Streams

49. 3. Reconcile Names ● maze ● start ● current ● exit ● north, south, east, west ● switch ● flip

50. 3. Reconcile Names ● maze ● start (IANA) ● current (IANA) ● exit ● north, south, east, west ● switch ● flip

51. 3. Reconcile Names ● maze ● start (IANA) ● current (IANA) ● exit (microformats) ● north, south, east, west (microformats) ● switch ● flip

52. 3. Reconcile Names ● maze ● start (IANA) ● current (IANA) ● exit (microformats) ● north, south, east, west (microformats) ● switch ● flip edit (IANA)

53. 3. Reconcile Names ● http://mamund.com/rels/maze (RFC5988) ● start (IANA) ● current (IANA) ● exit (microformats) ● north, south, east, west (microformats) ● http://mamund.com.rels/switch (RFC5988) ● flip edit (IANA)

54. 3. Reconcile Names ● IANA o edit o start o current ● microformats o exit o north, south, east, west ● RFC5988 o http://mamund.com/rels/switch o http://mamund.com/rels/maze

55.

56. OK, that was the design part...

57. But I still need to implement it, right?

58. 4. Choose a Media Type

59. 4. Choose a Media Type ● Use application/json, application/xml ● Collection type: Atom, OData, Collection+JSON ● Free-form: HTML, Siren, HAL, JSON-LD ● Invent your own semantic type

60. 4. Choose a Media Type ● Use application/json, application/xml ● Collection type: Atom, OData, Collection+JSON ● Free-form: HTML, Siren, HAL, JSON-LD ● Invent your own semantic type

61. 4. Choose a Media Type ● Use application/json, application/xml ● Collection type: Atom, OData, Collection+JSON ● Free-form: HTML, Siren, HAL, JSON-LD ● Invent your own semantic type

62. 4. Choose a Media Type ● Use application/json, application/xml ● Collection type: Atom, OData, Collection+JSON ● Free-form: HTML, Siren, HAL, JSON-LD ● Invent your own semantic type

63. 4. Choose a Media Type ● Use application/json, application/xml ● Collection type: Atom, OData, Collection+JSON ● Free-form: HTML, Siren, HAL, JSON-LD ● Invent your own semantic type

64.

65.

66. Collection+JSON

67. UBER+xml

68. MAZE+xml

69. 5. Write a Profile

70.

71.

72. 6. Implementation

73. 6. Implementation ta-da!

74.

75.

76.

77.

78.

79.

80. And now we have running code!

81. Wait, what's step seven?

82. 7. Publication

83. 7. Publication ● Publish your "billboard" URL ● Publish your profile ● Register new rel values and/or media types ● Publish the documentation ● Consider "well-known" URIs

84. Now, you're done!

85. Seven Simple Steps 1. List the Semantic Descriptors 2. Draw a State Diagram 3. Reconcile Names 4. Write a Profile 5. Select a Media Type 6. Implementation 7. Publication

86. Some Final Advice

87. Resources are an implementation detail

88.

89. Don't fall into the collection trap

90.

91. Don't start with the representation format

92.

93. URL design doesn't matter

94.

95. Standard names are probably better than yours.

96.

97. Don't keep all the hypermedia in one place

98.

99.

100. Some Final Advice ● Resources are implementation details ● Don't fall into the collection trap ● Don't start w/ the representation format ● URL design doesn't matter ● Standard names are probably better than yours ● Don't keep all the hypermedia in one place

101. In Conclusion...

102.

103.

104.

105.

106.

107. In Conclusion... ● Don't confuse implementation w/ design ● Design is the hard part (high value) ● Implementation is the easy part (high speed) ● Avoid common design mistakes ● Go out and make lots of APIs!

108. API Design Methodology Mike Amundsen, CA / Layer7 @mamund

API Design Methodology - Mike Amundsen, Director of API Architecture, API Academy @ APIdays Sydney

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Viewers also liked

Viewers also liked (9)

Similar to API Design Methodology - Mike Amundsen, Director of API Architecture, API Academy @ APIdays Sydney

Similar to API Design Methodology - Mike Amundsen, Director of API Architecture, API Academy @ APIdays Sydney (20)

More from CA API Management

More from CA API Management (20)

Recently uploaded

Recently uploaded (20)

API Design Methodology - Mike Amundsen, Director of API Architecture, API Academy @ APIdays Sydney