RESTfest 2013 5 in 5: Hypermedia API Documentation. We're doing it wrong.

•

0 likes•1,288 views

In this five minute presentation, I argue the tools we use (Swagger, I/O Docs, APIary) are teaching developers to code to URLs which will limit HAPI adoption. Video available here: http://vimeo.com/75256658

Technology

Documenting
Hypermedia APIs
Luke Stokes @lukestokes FoxyCart.com

HAPI adoption
“It’s not REST if it’s not HATEOS.”
“Show me the hypermedia.”
…
But we teach developers to code to URLs
(Swagger, I/O Docs, APIary, etc)

Tools can promote link relationships! (HAL Browser)

Documentation to help us think in relationships...

Coding to link relations
https://api.foxycart.com
more coders thinking in hypermedia = more
HAPI coders
more HAPI coders building for hypermedia =
more hypermedia tools and clients

Recently uploaded

Emixa Mendix Meetup 11 April 2024 about Mendix Native developmentPim van der Noll

Genislab builds better products and faster go-to-market with Lean project man...Farhan Tariq

Time Series Foundation Models - current state and future directionsNathaniel Shimoni

Long journey of Ruby standard library at RubyConf AU 2024Hiroshi SHIBATA

Scale your database traffic with Read & Write split using MySQL RouterMydbops

Moving Beyond Passwords: FIDO Paris Seminar.pdfLoriGlavin3

Unleashing Real-time Insights with ClickHouse_ Navigating the Landscape in 20...Alkin Tezuysal

What is DBT - The Ultimate Data Build Tool.pdfMounikaPolabathina

DevEX - reference for building teams, processes, and platformsSergiu Bodiu

Digital Identity is Under Attack: FIDO Paris Seminar.pptxLoriGlavin3

So einfach geht modernes Roaming fuer Notes und Nomad.pdfpanagenda

The Future Roadmap for the Composable Data Stack - Wes McKinney - Data Counci...Wes McKinney

Data governance with Unity Catalog PresentationKnoldus Inc.

Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024BookNet Canada

Passkey Providers and Enabling Portability: FIDO Paris Seminar.pptxLoriGlavin3

Take control of your SAP testing with UiPath Test SuiteDianaGray10

From Family Reminiscence to Scholarly Archive .Alan Dix

Generative AI for Technical Writer or Information DevelopersRaghuram Pandurangan

The State of Passkeys with FIDO Alliance.pptxLoriGlavin3

Manual 508 Accessibility Compliance AuditSkynet Technologies

Recently uploaded (20)

Emixa Mendix Meetup 11 April 2024 about Mendix Native development

Genislab builds better products and faster go-to-market with Lean project man...

Time Series Foundation Models - current state and future directions

Long journey of Ruby standard library at RubyConf AU 2024

Scale your database traffic with Read & Write split using MySQL Router

Moving Beyond Passwords: FIDO Paris Seminar.pdf

Unleashing Real-time Insights with ClickHouse_ Navigating the Landscape in 20...

What is DBT - The Ultimate Data Build Tool.pdf

DevEX - reference for building teams, processes, and platforms

Digital Identity is Under Attack: FIDO Paris Seminar.pptx

So einfach geht modernes Roaming fuer Notes und Nomad.pdf

The Future Roadmap for the Composable Data Stack - Wes McKinney - Data Counci...

Data governance with Unity Catalog Presentation

Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024

Passkey Providers and Enabling Portability: FIDO Paris Seminar.pptx

Take control of your SAP testing with UiPath Test Suite

From Family Reminiscence to Scholarly Archive .

Generative AI for Technical Writer or Information Developers

The State of Passkeys with FIDO Alliance.pptx

Manual 508 Accessibility Compliance Audit

Featured

Product Design Trends in 2024 | Teenage EngineeringsPixeldarts

How Race, Age and Gender Shape Attitudes Towards Mental HealthThinkNow

AI Trends in Creative Operations 2024 by Artwork Flow.pdfmarketingartwork

Skeleton Culture CodeSkeleton Technologies

PEPSICO Presentation to CAGNY Conference Feb 2024Neil Kimberley

Content Methodology: A Best Practices Report (Webinar)contently

How to Prepare For a Successful Job Search for 2024Albert Qian

Social Media Marketing Trends 2024 // The Global Indie InsightsKurio // The Social Media Age(ncy)

Trends In Paid Search: Navigating The Digital Landscape In 2024Search Engine Journal

5 Public speaking tips from TED - Visualized summarySpeakerHub

ChatGPT and the Future of Work - Clark Boyd Clark Boyd

Getting into the tech field. what next Tessa Mero

Google's Just Not That Into You: Understanding Core Updates & Search IntentLily Ray

How to have difficult conversations Rajiv Jayarajah, MAppComm, ACC

Introduction to Data ScienceChristy Abraham Joy

Time Management & Productivity - Best PracticesVit Horky

The six step guide to practical project managementMindGenius

Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...RachelPearson36

Unlocking the Power of ChatGPT and AI in Testing - A Real-World Look, present...Applitools

12 Ways to Increase Your Influence at WorkGetSmarter

Featured (20)

Product Design Trends in 2024 | Teenage Engineerings

How Race, Age and Gender Shape Attitudes Towards Mental Health

AI Trends in Creative Operations 2024 by Artwork Flow.pdf

Skeleton Culture Code

PEPSICO Presentation to CAGNY Conference Feb 2024

Content Methodology: A Best Practices Report (Webinar)

How to Prepare For a Successful Job Search for 2024

Social Media Marketing Trends 2024 // The Global Indie Insights

Trends In Paid Search: Navigating The Digital Landscape In 2024

5 Public speaking tips from TED - Visualized summary

ChatGPT and the Future of Work - Clark Boyd

Getting into the tech field. what next

Google's Just Not That Into You: Understanding Core Updates & Search Intent

How to have difficult conversations

Introduction to Data Science

Time Management & Productivity - Best Practices

The six step guide to practical project management

Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...

Unlocking the Power of ChatGPT and AI in Testing - A Real-World Look, present...

12 Ways to Increase Your Influence at Work