SlideShare a Scribd company logo
A	
  Quick	
  Introduc.on	
  
About  me
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
•  European	
  Ci.zen	
  
•  Technology	
  =	
  Love	
  
•  Developer	
  
•  Sporty	
  (at	
  least	
  some.mes)	
  
•  Not	
  a	
  Brit	
  
•  and	
  more	
  …	
  
Chris.an	
  Vogel	
  
Community	
  PM	
  /	
  Evangelist	
  
MulesoO	
  
@Chris.anVogel_	
  
Remember?
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
Bo.om-­‐up
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
Top-­‐down
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
Specifica(on	
  
Today?
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
Pure	
  
documents	
  
BoRom	
  
up	
  
Top	
  
down	
  
Make  Your  Choice
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
and	
  more	
  
RAML	
  
API	
  Design	
  First	
  
RAML
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
A new open spec
for RESTful APIs
that's as clean
and as structured
as REST itself
RESTful API Modeling Language
the RAML Workgroup:
raml.org
RAML:  Human  Readable
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
Choose  your  format!
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
API	
  
Console	
  
Choose  your  format!
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
Slate	
  
Choose  your  format!
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
HTML	
  
PDF	
  
Word	
  
or	
  others	
  
RAML	
  
Write	
  once.	
  	
  Use	
  many.	
  	
  Crea.ve	
  laziness	
  encouraged.	
  
RAML:  Common  Pa.erns
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
Resource Types
•  Collection
•  Collection Member
•  Document
Traits
•  Secure
•  Paged
Define Share Reuse
RAML:  Common  Pa.erns
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
resource type
schema
trait
 
RAML	
  1.0	
  
WHAT’S	
  NEW	
  
Data	
  Models	
  
complex	
  schemas	
  and	
  examples	
  become	
  simply	
  typed	
  models	
  that	
  can	
  be	
  
used	
  for	
  code	
  genera.on,	
  clear	
  interpreta.on,	
  example	
  genera.on,	
  and	
  
yes	
  –	
  even	
  mul.-­‐format	
  schema	
  genera.on.	
  
OR	
  
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
Data	
  Models	
  
	
  
data	
  models	
  are	
  easily	
  pulled	
  in	
  to	
  
other	
  models,	
  used	
  as	
  schemas/	
  
examples,	
  and	
  can	
  even	
  be	
  stored	
  in	
  
libraries	
  and	
  namespaced!	
  
	
  
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
Libraries	
  
resourceTypes,	
  traits,	
  schemas,	
  examples,	
  data	
  types	
  (models),	
  and	
  more	
  
can	
  all	
  be	
  stored	
  in	
  libraries,	
  which	
  can	
  then	
  be	
  pulled	
  into	
  the	
  RAML	
  spec	
  
in	
  a	
  namespaced	
  format	
  –	
  leang	
  you	
  reuse	
  what	
  you	
  want,	
  and	
  ignore	
  
what	
  you	
  don’t.	
  
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
Overlays	
  
your	
  API	
  doesn’t	
  just	
  live	
  in	
  one	
  environment,	
  so	
  neither	
  should	
  your	
  
design,	
  documenta.on,	
  or	
  tests.	
  	
  Overlays	
  let	
  you	
  “extend”	
  your	
  RAML	
  
spec	
  for	
  your	
  development,	
  QA,	
  and	
  produc.on	
  environments.	
  
Original	
  Spec	
   Overlay	
  seang	
  Produc.on	
  Values	
  
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
Annota.ons	
  
vendor	
  extensions	
  shouldn’t	
  be	
  a	
  pain,	
  and	
  in	
  RAML	
  –	
  they’re	
  just	
  “new”	
  
proper.es	
  in	
  your	
  spec.	
  
Plus	
  you	
  can	
  use	
  libraries	
  
and	
  overlays	
  to	
  keep	
  
annota.ons	
  separate	
  
from	
  your	
  main	
  spec,	
  
meaning	
  they	
  are	
  only	
  
visible	
  to	
  the	
  vendor	
  you	
  
want	
  using	
  them,	
  and	
  
out	
  of	
  the	
  way	
  of	
  your	
  
developers/	
  tech	
  
writers/	
  CEO!	
  
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
And	
  a	
  lot	
  more…	
  	
  
Plus+	
  
API	
  Workbench	
  
a	
  brand	
  new	
  IDE	
  to	
  design	
  APIs	
  online	
  AND	
  offline,	
  built	
  on	
  top	
  of	
  GitHub’s	
  
Atom	
  project,	
  meaning	
  collabora.on	
  and	
  versioning	
  have	
  never	
  been	
  
easier!	
  	
  Finally,	
  a	
  tool	
  for	
  developers	
  to	
  design	
  APIs	
  with!	
  
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
API Documentation Meetup 2016, London
API Documentation Meetup 2016, London
What  else?
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
#	
  of	
  downloads	
  
API	
  Workbench	
  
13.7k	
  
#	
  of	
  project	
  
views	
  
750k	
  
RAML.org	
  
APIWorkbench.com	
  
@ramlapi	
  
raml-­‐org/raml-­‐spec	
  
API	
  Documenta.on	
  Meetup	
  2016,	
  London	
  
Ad

More Related Content

What's hot (18)

Documenting REST APIs
Documenting REST APIsDocumenting REST APIs
Documenting REST APIs
Tom Johnson
 
Publishing API documentation -- Workshop
Publishing API documentation -- WorkshopPublishing API documentation -- Workshop
Publishing API documentation -- Workshop
Tom Johnson
 
RAML - APIs By Design
RAML - APIs By DesignRAML - APIs By Design
RAML - APIs By Design
Uri Sarid
 
API Documentation Workshop tcworld India 2015
API Documentation Workshop tcworld India 2015API Documentation Workshop tcworld India 2015
API Documentation Workshop tcworld India 2015
Tom Johnson
 
apidays LIVE Paris 2021 - Learning the Language of HTTP for a Better Data Exp...
apidays LIVE Paris 2021 - Learning the Language of HTTP for a Better Data Exp...apidays LIVE Paris 2021 - Learning the Language of HTTP for a Better Data Exp...
apidays LIVE Paris 2021 - Learning the Language of HTTP for a Better Data Exp...
apidays
 
Survival Strategies for API Documentation: Presentation to Southwestern Ontar...
Survival Strategies for API Documentation: Presentation to Southwestern Ontar...Survival Strategies for API Documentation: Presentation to Southwestern Ontar...
Survival Strategies for API Documentation: Presentation to Southwestern Ontar...
Tom Johnson
 
Mulesoft Raml APIs
Mulesoft Raml APIsMulesoft Raml APIs
Mulesoft Raml APIs
akshay yeluru
 
Scala & Swagger at Wordnik
Scala & Swagger at WordnikScala & Swagger at Wordnik
Scala & Swagger at Wordnik
Tony Tam
 
API Documentation -- Presentation to East Bay STC Chapter
API Documentation -- Presentation to East Bay STC ChapterAPI Documentation -- Presentation to East Bay STC Chapter
API Documentation -- Presentation to East Bay STC Chapter
Tom Johnson
 
REST Coder: Auto Generating Client Stubs and Documentation for REST APIs
REST Coder: Auto Generating Client Stubs and Documentation for REST APIsREST Coder: Auto Generating Client Stubs and Documentation for REST APIs
REST Coder: Auto Generating Client Stubs and Documentation for REST APIs
Hiranya Jayathilaka
 
What is Swagger?
What is Swagger?What is Swagger?
What is Swagger?
Philip Senger
 
Using RAML 1.0 Like a Pro
Using RAML 1.0 Like a ProUsing RAML 1.0 Like a Pro
Using RAML 1.0 Like a Pro
MuleSoft
 
Empathic API-Design
Empathic API-DesignEmpathic API-Design
Empathic API-Design
Corneil du Plessis
 
Open Source examples from Adobe : Oscon kiosk
Open Source examples from Adobe : Oscon kioskOpen Source examples from Adobe : Oscon kiosk
Open Source examples from Adobe : Oscon kiosk
Dave McAllister
 
Synopsis on apache open office
Synopsis on apache open office Synopsis on apache open office
Synopsis on apache open office
Bhitesh Arora
 
apidays LIVE London 2021 - Designing APIs: Less Data is More by Damir Svrtan,...
apidays LIVE London 2021 - Designing APIs: Less Data is More by Damir Svrtan,...apidays LIVE London 2021 - Designing APIs: Less Data is More by Damir Svrtan,...
apidays LIVE London 2021 - Designing APIs: Less Data is More by Damir Svrtan,...
apidays
 
LibreOffice Training Presentation
LibreOffice Training PresentationLibreOffice Training Presentation
LibreOffice Training Presentation
Bob McDonald
 
OpenOffice at Apache
OpenOffice at ApacheOpenOffice at Apache
OpenOffice at Apache
pescetti
 
Documenting REST APIs
Documenting REST APIsDocumenting REST APIs
Documenting REST APIs
Tom Johnson
 
Publishing API documentation -- Workshop
Publishing API documentation -- WorkshopPublishing API documentation -- Workshop
Publishing API documentation -- Workshop
Tom Johnson
 
RAML - APIs By Design
RAML - APIs By DesignRAML - APIs By Design
RAML - APIs By Design
Uri Sarid
 
API Documentation Workshop tcworld India 2015
API Documentation Workshop tcworld India 2015API Documentation Workshop tcworld India 2015
API Documentation Workshop tcworld India 2015
Tom Johnson
 
apidays LIVE Paris 2021 - Learning the Language of HTTP for a Better Data Exp...
apidays LIVE Paris 2021 - Learning the Language of HTTP for a Better Data Exp...apidays LIVE Paris 2021 - Learning the Language of HTTP for a Better Data Exp...
apidays LIVE Paris 2021 - Learning the Language of HTTP for a Better Data Exp...
apidays
 
Survival Strategies for API Documentation: Presentation to Southwestern Ontar...
Survival Strategies for API Documentation: Presentation to Southwestern Ontar...Survival Strategies for API Documentation: Presentation to Southwestern Ontar...
Survival Strategies for API Documentation: Presentation to Southwestern Ontar...
Tom Johnson
 
Scala & Swagger at Wordnik
Scala & Swagger at WordnikScala & Swagger at Wordnik
Scala & Swagger at Wordnik
Tony Tam
 
API Documentation -- Presentation to East Bay STC Chapter
API Documentation -- Presentation to East Bay STC ChapterAPI Documentation -- Presentation to East Bay STC Chapter
API Documentation -- Presentation to East Bay STC Chapter
Tom Johnson
 
REST Coder: Auto Generating Client Stubs and Documentation for REST APIs
REST Coder: Auto Generating Client Stubs and Documentation for REST APIsREST Coder: Auto Generating Client Stubs and Documentation for REST APIs
REST Coder: Auto Generating Client Stubs and Documentation for REST APIs
Hiranya Jayathilaka
 
Using RAML 1.0 Like a Pro
Using RAML 1.0 Like a ProUsing RAML 1.0 Like a Pro
Using RAML 1.0 Like a Pro
MuleSoft
 
Open Source examples from Adobe : Oscon kiosk
Open Source examples from Adobe : Oscon kioskOpen Source examples from Adobe : Oscon kiosk
Open Source examples from Adobe : Oscon kiosk
Dave McAllister
 
Synopsis on apache open office
Synopsis on apache open office Synopsis on apache open office
Synopsis on apache open office
Bhitesh Arora
 
apidays LIVE London 2021 - Designing APIs: Less Data is More by Damir Svrtan,...
apidays LIVE London 2021 - Designing APIs: Less Data is More by Damir Svrtan,...apidays LIVE London 2021 - Designing APIs: Less Data is More by Damir Svrtan,...
apidays LIVE London 2021 - Designing APIs: Less Data is More by Damir Svrtan,...
apidays
 
LibreOffice Training Presentation
LibreOffice Training PresentationLibreOffice Training Presentation
LibreOffice Training Presentation
Bob McDonald
 
OpenOffice at Apache
OpenOffice at ApacheOpenOffice at Apache
OpenOffice at Apache
pescetti
 

Similar to API Documentation Meetup 2016, London (20)

Alternatives to SQL - a Laravel Perspective
Alternatives to SQL - a Laravel PerspectiveAlternatives to SQL - a Laravel Perspective
Alternatives to SQL - a Laravel Perspective
Peter Coles
 
6 Best OpenAPI Documentation Tools that You must Know
6 Best OpenAPI Documentation Tools that You must Know6 Best OpenAPI Documentation Tools that You must Know
6 Best OpenAPI Documentation Tools that You must Know
Mars Devs
 
Apidays Paris 2023 - API design first: A case for a better language, Emmanu...
Apidays Paris 2023  -  API design first: A case for a better language, Emmanu...Apidays Paris 2023  -  API design first: A case for a better language, Emmanu...
Apidays Paris 2023 - API design first: A case for a better language, Emmanu...
apidays
 
Open Source Tools for User Assistance
Open Source Tools for User AssistanceOpen Source Tools for User Assistance
Open Source Tools for User Assistance
Michael McCallister
 
Open APIs and the Semantic Web 2011
Open APIs and the Semantic Web 2011Open APIs and the Semantic Web 2011
Open APIs and the Semantic Web 2011
John Musser
 
What is Design Center | API Designer | API Specification
What is Design Center | API Designer | API SpecificationWhat is Design Center | API Designer | API Specification
What is Design Center | API Designer | API Specification
Rahul Vijayanagaram
 
API-Design-Using-ChatGPT
API-Design-Using-ChatGPTAPI-Design-Using-ChatGPT
API-Design-Using-ChatGPT
Rahul Dighe
 
OracleDeveloperMeetup - London 19-12-17
OracleDeveloperMeetup - London 19-12-17OracleDeveloperMeetup - London 19-12-17
OracleDeveloperMeetup - London 19-12-17
Phil Wilkins
 
API Marketing: First Comes Usability, Then Discoverability
API Marketing: First Comes Usability, Then DiscoverabilityAPI Marketing: First Comes Usability, Then Discoverability
API Marketing: First Comes Usability, Then Discoverability
Bill Doerrfeld
 
LF_APIStrat17_API Marketing: First Comes Usability, then Discoverability
LF_APIStrat17_API Marketing: First Comes Usability, then DiscoverabilityLF_APIStrat17_API Marketing: First Comes Usability, then Discoverability
LF_APIStrat17_API Marketing: First Comes Usability, then Discoverability
LF_APIStrat
 
A Snapshot of API Design Trends In 2019
A Snapshot of API Design Trends In 2019A Snapshot of API Design Trends In 2019
A Snapshot of API Design Trends In 2019
Bill Doerrfeld
 
Building a REST API for Longevity
Building a REST API for LongevityBuilding a REST API for Longevity
Building a REST API for Longevity
MuleSoft
 
API Design Principles using Oracle Apiary.io
API Design Principles using Oracle Apiary.ioAPI Design Principles using Oracle Apiary.io
API Design Principles using Oracle Apiary.io
Rolando Carrasco
 
Styleguide for your APIs
Styleguide for your APIsStyleguide for your APIs
Styleguide for your APIs
Rolando Carrasco
 
Getting to Grips with RESTful APIs
Getting to Grips with RESTful APIsGetting to Grips with RESTful APIs
Getting to Grips with RESTful APIs
Petko Mikhailov
 
The relevance of design principles for WEB APIs
The relevance of design principles for WEB APIsThe relevance of design principles for WEB APIs
The relevance of design principles for WEB APIs
Rolando Carrasco
 
A Journey from API Versioning to Canary Release | Nordic APIs Platform Summit...
A Journey from API Versioning to Canary Release | Nordic APIs Platform Summit...A Journey from API Versioning to Canary Release | Nordic APIs Platform Summit...
A Journey from API Versioning to Canary Release | Nordic APIs Platform Summit...
Patrice Krakow
 
mulesoft birmingham meetup_api_designing_with_raml
mulesoft birmingham meetup_api_designing_with_ramlmulesoft birmingham meetup_api_designing_with_raml
mulesoft birmingham meetup_api_designing_with_raml
mohammadsakifuddin
 
Open API Ecosystem Overview: December 2010
Open API Ecosystem Overview: December 2010Open API Ecosystem Overview: December 2010
Open API Ecosystem Overview: December 2010
John Musser
 
APIs at Scale with TypeSpec by Mandy Whaley, Microsoft
APIs at Scale with TypeSpec by Mandy Whaley, MicrosoftAPIs at Scale with TypeSpec by Mandy Whaley, Microsoft
APIs at Scale with TypeSpec by Mandy Whaley, Microsoft
Nordic APIs
 
Alternatives to SQL - a Laravel Perspective
Alternatives to SQL - a Laravel PerspectiveAlternatives to SQL - a Laravel Perspective
Alternatives to SQL - a Laravel Perspective
Peter Coles
 
6 Best OpenAPI Documentation Tools that You must Know
6 Best OpenAPI Documentation Tools that You must Know6 Best OpenAPI Documentation Tools that You must Know
6 Best OpenAPI Documentation Tools that You must Know
Mars Devs
 
Apidays Paris 2023 - API design first: A case for a better language, Emmanu...
Apidays Paris 2023  -  API design first: A case for a better language, Emmanu...Apidays Paris 2023  -  API design first: A case for a better language, Emmanu...
Apidays Paris 2023 - API design first: A case for a better language, Emmanu...
apidays
 
Open Source Tools for User Assistance
Open Source Tools for User AssistanceOpen Source Tools for User Assistance
Open Source Tools for User Assistance
Michael McCallister
 
Open APIs and the Semantic Web 2011
Open APIs and the Semantic Web 2011Open APIs and the Semantic Web 2011
Open APIs and the Semantic Web 2011
John Musser
 
What is Design Center | API Designer | API Specification
What is Design Center | API Designer | API SpecificationWhat is Design Center | API Designer | API Specification
What is Design Center | API Designer | API Specification
Rahul Vijayanagaram
 
API-Design-Using-ChatGPT
API-Design-Using-ChatGPTAPI-Design-Using-ChatGPT
API-Design-Using-ChatGPT
Rahul Dighe
 
OracleDeveloperMeetup - London 19-12-17
OracleDeveloperMeetup - London 19-12-17OracleDeveloperMeetup - London 19-12-17
OracleDeveloperMeetup - London 19-12-17
Phil Wilkins
 
API Marketing: First Comes Usability, Then Discoverability
API Marketing: First Comes Usability, Then DiscoverabilityAPI Marketing: First Comes Usability, Then Discoverability
API Marketing: First Comes Usability, Then Discoverability
Bill Doerrfeld
 
LF_APIStrat17_API Marketing: First Comes Usability, then Discoverability
LF_APIStrat17_API Marketing: First Comes Usability, then DiscoverabilityLF_APIStrat17_API Marketing: First Comes Usability, then Discoverability
LF_APIStrat17_API Marketing: First Comes Usability, then Discoverability
LF_APIStrat
 
A Snapshot of API Design Trends In 2019
A Snapshot of API Design Trends In 2019A Snapshot of API Design Trends In 2019
A Snapshot of API Design Trends In 2019
Bill Doerrfeld
 
Building a REST API for Longevity
Building a REST API for LongevityBuilding a REST API for Longevity
Building a REST API for Longevity
MuleSoft
 
API Design Principles using Oracle Apiary.io
API Design Principles using Oracle Apiary.ioAPI Design Principles using Oracle Apiary.io
API Design Principles using Oracle Apiary.io
Rolando Carrasco
 
Getting to Grips with RESTful APIs
Getting to Grips with RESTful APIsGetting to Grips with RESTful APIs
Getting to Grips with RESTful APIs
Petko Mikhailov
 
The relevance of design principles for WEB APIs
The relevance of design principles for WEB APIsThe relevance of design principles for WEB APIs
The relevance of design principles for WEB APIs
Rolando Carrasco
 
A Journey from API Versioning to Canary Release | Nordic APIs Platform Summit...
A Journey from API Versioning to Canary Release | Nordic APIs Platform Summit...A Journey from API Versioning to Canary Release | Nordic APIs Platform Summit...
A Journey from API Versioning to Canary Release | Nordic APIs Platform Summit...
Patrice Krakow
 
mulesoft birmingham meetup_api_designing_with_raml
mulesoft birmingham meetup_api_designing_with_ramlmulesoft birmingham meetup_api_designing_with_raml
mulesoft birmingham meetup_api_designing_with_raml
mohammadsakifuddin
 
Open API Ecosystem Overview: December 2010
Open API Ecosystem Overview: December 2010Open API Ecosystem Overview: December 2010
Open API Ecosystem Overview: December 2010
John Musser
 
APIs at Scale with TypeSpec by Mandy Whaley, Microsoft
APIs at Scale with TypeSpec by Mandy Whaley, MicrosoftAPIs at Scale with TypeSpec by Mandy Whaley, Microsoft
APIs at Scale with TypeSpec by Mandy Whaley, Microsoft
Nordic APIs
 
Ad

Recently uploaded (20)

Adobe Lightroom Classic Crack FREE Latest link 2025
Adobe Lightroom Classic Crack FREE Latest link 2025Adobe Lightroom Classic Crack FREE Latest link 2025
Adobe Lightroom Classic Crack FREE Latest link 2025
kashifyounis067
 
Solidworks Crack 2025 latest new + license code
Solidworks Crack 2025 latest new + license codeSolidworks Crack 2025 latest new + license code
Solidworks Crack 2025 latest new + license code
aneelaramzan63
 
Avast Premium Security Crack FREE Latest Version 2025
Avast Premium Security Crack FREE Latest Version 2025Avast Premium Security Crack FREE Latest Version 2025
Avast Premium Security Crack FREE Latest Version 2025
mu394968
 
Exploring Code Comprehension in Scientific Programming: Preliminary Insight...
Exploring Code Comprehension  in Scientific Programming:  Preliminary Insight...Exploring Code Comprehension  in Scientific Programming:  Preliminary Insight...
Exploring Code Comprehension in Scientific Programming: Preliminary Insight...
University of Hawai‘i at Mānoa
 
How can one start with crypto wallet development.pptx
How can one start with crypto wallet development.pptxHow can one start with crypto wallet development.pptx
How can one start with crypto wallet development.pptx
laravinson24
 
Download YouTube By Click 2025 Free Full Activated
Download YouTube By Click 2025 Free Full ActivatedDownload YouTube By Click 2025 Free Full Activated
Download YouTube By Click 2025 Free Full Activated
saniamalik72555
 
Exploring Wayland: A Modern Display Server for the Future
Exploring Wayland: A Modern Display Server for the FutureExploring Wayland: A Modern Display Server for the Future
Exploring Wayland: A Modern Display Server for the Future
ICS
 
Get & Download Wondershare Filmora Crack Latest [2025]
Get & Download Wondershare Filmora Crack Latest [2025]Get & Download Wondershare Filmora Crack Latest [2025]
Get & Download Wondershare Filmora Crack Latest [2025]
saniaaftab72555
 
Adobe Illustrator Crack FREE Download 2025 Latest Version
Adobe Illustrator Crack FREE Download 2025 Latest VersionAdobe Illustrator Crack FREE Download 2025 Latest Version
Adobe Illustrator Crack FREE Download 2025 Latest Version
kashifyounis067
 
Expand your AI adoption with AgentExchange
Expand your AI adoption with AgentExchangeExpand your AI adoption with AgentExchange
Expand your AI adoption with AgentExchange
Fexle Services Pvt. Ltd.
 
Adobe Master Collection CC Crack Advance Version 2025
Adobe Master Collection CC Crack Advance Version 2025Adobe Master Collection CC Crack Advance Version 2025
Adobe Master Collection CC Crack Advance Version 2025
kashifyounis067
 
Exceptional Behaviors: How Frequently Are They Tested? (AST 2025)
Exceptional Behaviors: How Frequently Are They Tested? (AST 2025)Exceptional Behaviors: How Frequently Are They Tested? (AST 2025)
Exceptional Behaviors: How Frequently Are They Tested? (AST 2025)
Andre Hora
 
Societal challenges of AI: biases, multilinguism and sustainability
Societal challenges of AI: biases, multilinguism and sustainabilitySocietal challenges of AI: biases, multilinguism and sustainability
Societal challenges of AI: biases, multilinguism and sustainability
Jordi Cabot
 
Designing AI-Powered APIs on Azure: Best Practices& Considerations
Designing AI-Powered APIs on Azure: Best Practices& ConsiderationsDesigning AI-Powered APIs on Azure: Best Practices& Considerations
Designing AI-Powered APIs on Azure: Best Practices& Considerations
Dinusha Kumarasiri
 
Kubernetes_101_Zero_to_Platform_Engineer.pptx
Kubernetes_101_Zero_to_Platform_Engineer.pptxKubernetes_101_Zero_to_Platform_Engineer.pptx
Kubernetes_101_Zero_to_Platform_Engineer.pptx
CloudScouts
 
Microsoft AI Nonprofit Use Cases and Live Demo_2025.04.30.pdf
Microsoft AI Nonprofit Use Cases and Live Demo_2025.04.30.pdfMicrosoft AI Nonprofit Use Cases and Live Demo_2025.04.30.pdf
Microsoft AI Nonprofit Use Cases and Live Demo_2025.04.30.pdf
TechSoup
 
PDF Reader Pro Crack Latest Version FREE Download 2025
PDF Reader Pro Crack Latest Version FREE Download 2025PDF Reader Pro Crack Latest Version FREE Download 2025
PDF Reader Pro Crack Latest Version FREE Download 2025
mu394968
 
Revolutionizing Residential Wi-Fi PPT.pptx
Revolutionizing Residential Wi-Fi PPT.pptxRevolutionizing Residential Wi-Fi PPT.pptx
Revolutionizing Residential Wi-Fi PPT.pptx
nidhisingh691197
 
Secure Test Infrastructure: The Backbone of Trustworthy Software Development
Secure Test Infrastructure: The Backbone of Trustworthy Software DevelopmentSecure Test Infrastructure: The Backbone of Trustworthy Software Development
Secure Test Infrastructure: The Backbone of Trustworthy Software Development
Shubham Joshi
 
Explaining GitHub Actions Failures with Large Language Models Challenges, In...
Explaining GitHub Actions Failures with Large Language Models Challenges, In...Explaining GitHub Actions Failures with Large Language Models Challenges, In...
Explaining GitHub Actions Failures with Large Language Models Challenges, In...
ssuserb14185
 
Adobe Lightroom Classic Crack FREE Latest link 2025
Adobe Lightroom Classic Crack FREE Latest link 2025Adobe Lightroom Classic Crack FREE Latest link 2025
Adobe Lightroom Classic Crack FREE Latest link 2025
kashifyounis067
 
Solidworks Crack 2025 latest new + license code
Solidworks Crack 2025 latest new + license codeSolidworks Crack 2025 latest new + license code
Solidworks Crack 2025 latest new + license code
aneelaramzan63
 
Avast Premium Security Crack FREE Latest Version 2025
Avast Premium Security Crack FREE Latest Version 2025Avast Premium Security Crack FREE Latest Version 2025
Avast Premium Security Crack FREE Latest Version 2025
mu394968
 
Exploring Code Comprehension in Scientific Programming: Preliminary Insight...
Exploring Code Comprehension  in Scientific Programming:  Preliminary Insight...Exploring Code Comprehension  in Scientific Programming:  Preliminary Insight...
Exploring Code Comprehension in Scientific Programming: Preliminary Insight...
University of Hawai‘i at Mānoa
 
How can one start with crypto wallet development.pptx
How can one start with crypto wallet development.pptxHow can one start with crypto wallet development.pptx
How can one start with crypto wallet development.pptx
laravinson24
 
Download YouTube By Click 2025 Free Full Activated
Download YouTube By Click 2025 Free Full ActivatedDownload YouTube By Click 2025 Free Full Activated
Download YouTube By Click 2025 Free Full Activated
saniamalik72555
 
Exploring Wayland: A Modern Display Server for the Future
Exploring Wayland: A Modern Display Server for the FutureExploring Wayland: A Modern Display Server for the Future
Exploring Wayland: A Modern Display Server for the Future
ICS
 
Get & Download Wondershare Filmora Crack Latest [2025]
Get & Download Wondershare Filmora Crack Latest [2025]Get & Download Wondershare Filmora Crack Latest [2025]
Get & Download Wondershare Filmora Crack Latest [2025]
saniaaftab72555
 
Adobe Illustrator Crack FREE Download 2025 Latest Version
Adobe Illustrator Crack FREE Download 2025 Latest VersionAdobe Illustrator Crack FREE Download 2025 Latest Version
Adobe Illustrator Crack FREE Download 2025 Latest Version
kashifyounis067
 
Expand your AI adoption with AgentExchange
Expand your AI adoption with AgentExchangeExpand your AI adoption with AgentExchange
Expand your AI adoption with AgentExchange
Fexle Services Pvt. Ltd.
 
Adobe Master Collection CC Crack Advance Version 2025
Adobe Master Collection CC Crack Advance Version 2025Adobe Master Collection CC Crack Advance Version 2025
Adobe Master Collection CC Crack Advance Version 2025
kashifyounis067
 
Exceptional Behaviors: How Frequently Are They Tested? (AST 2025)
Exceptional Behaviors: How Frequently Are They Tested? (AST 2025)Exceptional Behaviors: How Frequently Are They Tested? (AST 2025)
Exceptional Behaviors: How Frequently Are They Tested? (AST 2025)
Andre Hora
 
Societal challenges of AI: biases, multilinguism and sustainability
Societal challenges of AI: biases, multilinguism and sustainabilitySocietal challenges of AI: biases, multilinguism and sustainability
Societal challenges of AI: biases, multilinguism and sustainability
Jordi Cabot
 
Designing AI-Powered APIs on Azure: Best Practices& Considerations
Designing AI-Powered APIs on Azure: Best Practices& ConsiderationsDesigning AI-Powered APIs on Azure: Best Practices& Considerations
Designing AI-Powered APIs on Azure: Best Practices& Considerations
Dinusha Kumarasiri
 
Kubernetes_101_Zero_to_Platform_Engineer.pptx
Kubernetes_101_Zero_to_Platform_Engineer.pptxKubernetes_101_Zero_to_Platform_Engineer.pptx
Kubernetes_101_Zero_to_Platform_Engineer.pptx
CloudScouts
 
Microsoft AI Nonprofit Use Cases and Live Demo_2025.04.30.pdf
Microsoft AI Nonprofit Use Cases and Live Demo_2025.04.30.pdfMicrosoft AI Nonprofit Use Cases and Live Demo_2025.04.30.pdf
Microsoft AI Nonprofit Use Cases and Live Demo_2025.04.30.pdf
TechSoup
 
PDF Reader Pro Crack Latest Version FREE Download 2025
PDF Reader Pro Crack Latest Version FREE Download 2025PDF Reader Pro Crack Latest Version FREE Download 2025
PDF Reader Pro Crack Latest Version FREE Download 2025
mu394968
 
Revolutionizing Residential Wi-Fi PPT.pptx
Revolutionizing Residential Wi-Fi PPT.pptxRevolutionizing Residential Wi-Fi PPT.pptx
Revolutionizing Residential Wi-Fi PPT.pptx
nidhisingh691197
 
Secure Test Infrastructure: The Backbone of Trustworthy Software Development
Secure Test Infrastructure: The Backbone of Trustworthy Software DevelopmentSecure Test Infrastructure: The Backbone of Trustworthy Software Development
Secure Test Infrastructure: The Backbone of Trustworthy Software Development
Shubham Joshi
 
Explaining GitHub Actions Failures with Large Language Models Challenges, In...
Explaining GitHub Actions Failures with Large Language Models Challenges, In...Explaining GitHub Actions Failures with Large Language Models Challenges, In...
Explaining GitHub Actions Failures with Large Language Models Challenges, In...
ssuserb14185
 
Ad

API Documentation Meetup 2016, London

  • 2. About  me API  Documenta.on  Meetup  2016,  London   •  European  Ci.zen   •  Technology  =  Love   •  Developer   •  Sporty  (at  least  some.mes)   •  Not  a  Brit   •  and  more  …   Chris.an  Vogel   Community  PM  /  Evangelist   MulesoO   @Chris.anVogel_  
  • 5. Top-­‐down API  Documenta.on  Meetup  2016,  London   Specifica(on  
  • 6. Today? API  Documenta.on  Meetup  2016,  London   Pure   documents   BoRom   up   Top   down  
  • 7. Make  Your  Choice API  Documenta.on  Meetup  2016,  London   and  more  
  • 8. RAML   API  Design  First  
  • 9. RAML API  Documenta.on  Meetup  2016,  London   A new open spec for RESTful APIs that's as clean and as structured as REST itself RESTful API Modeling Language the RAML Workgroup: raml.org
  • 10. RAML:  Human  Readable API  Documenta.on  Meetup  2016,  London  
  • 11. Choose  your  format! API  Documenta.on  Meetup  2016,  London   API   Console  
  • 12. Choose  your  format! API  Documenta.on  Meetup  2016,  London   Slate  
  • 13. Choose  your  format! API  Documenta.on  Meetup  2016,  London   HTML   PDF   Word   or  others  
  • 14. RAML   Write  once.    Use  many.    Crea.ve  laziness  encouraged.  
  • 15. RAML:  Common  Pa.erns API  Documenta.on  Meetup  2016,  London   Resource Types •  Collection •  Collection Member •  Document Traits •  Secure •  Paged Define Share Reuse
  • 16. RAML:  Common  Pa.erns API  Documenta.on  Meetup  2016,  London   resource type schema trait
  • 18. Data  Models   complex  schemas  and  examples  become  simply  typed  models  that  can  be   used  for  code  genera.on,  clear  interpreta.on,  example  genera.on,  and   yes  –  even  mul.-­‐format  schema  genera.on.   OR   API  Documenta.on  Meetup  2016,  London  
  • 19. Data  Models     data  models  are  easily  pulled  in  to   other  models,  used  as  schemas/   examples,  and  can  even  be  stored  in   libraries  and  namespaced!     API  Documenta.on  Meetup  2016,  London  
  • 20. Libraries   resourceTypes,  traits,  schemas,  examples,  data  types  (models),  and  more   can  all  be  stored  in  libraries,  which  can  then  be  pulled  into  the  RAML  spec   in  a  namespaced  format  –  leang  you  reuse  what  you  want,  and  ignore   what  you  don’t.   API  Documenta.on  Meetup  2016,  London  
  • 21. Overlays   your  API  doesn’t  just  live  in  one  environment,  so  neither  should  your   design,  documenta.on,  or  tests.    Overlays  let  you  “extend”  your  RAML   spec  for  your  development,  QA,  and  produc.on  environments.   Original  Spec   Overlay  seang  Produc.on  Values   API  Documenta.on  Meetup  2016,  London  
  • 22. Annota.ons   vendor  extensions  shouldn’t  be  a  pain,  and  in  RAML  –  they’re  just  “new”   proper.es  in  your  spec.   Plus  you  can  use  libraries   and  overlays  to  keep   annota.ons  separate   from  your  main  spec,   meaning  they  are  only   visible  to  the  vendor  you   want  using  them,  and   out  of  the  way  of  your   developers/  tech   writers/  CEO!   API  Documenta.on  Meetup  2016,  London  
  • 23. And  a  lot  more…    
  • 25. API  Workbench   a  brand  new  IDE  to  design  APIs  online  AND  offline,  built  on  top  of  GitHub’s   Atom  project,  meaning  collabora.on  and  versioning  have  never  been   easier!    Finally,  a  tool  for  developers  to  design  APIs  with!   API  Documenta.on  Meetup  2016,  London  
  • 28. What  else? API  Documenta.on  Meetup  2016,  London   #  of  downloads   API  Workbench   13.7k   #  of  project   views   750k  
  • 29. RAML.org   APIWorkbench.com   @ramlapi   raml-­‐org/raml-­‐spec   API  Documenta.on  Meetup  2016,  London