Enviar pesquisa
Carregar
Building Self Documenting REST APIs
•
4 gostaram
•
4,520 visualizações
Yan Pritzker
Seguir
How to build self documenting APIs with HAL and Swagger
Leia menos
Leia mais
Internet
Denunciar
Compartilhar
Denunciar
Compartilhar
1 de 37
Baixar agora
Baixar para ler offline
Recomendados
Job descriptions aiesec in Turkey 2015:2016
Job descriptions aiesec in Turkey 2015:2016
Katarzyna Zielosko
APIsecure 2023 - API orchestration: to build resilient applications, Cherish ...
APIsecure 2023 - API orchestration: to build resilient applications, Cherish ...
apidays
Intel Developer Program
Intel Developer Program
Intel® Software
EY Studie: Top 500 FE Unternehmen
EY Studie: Top 500 FE Unternehmen
EY
DevOps 101 - an Introduction to DevOps
DevOps 101 - an Introduction to DevOps
Red Gate Software
Enterprise-architecture and the service-oriented enterprise
Enterprise-architecture and the service-oriented enterprise
Tetradian Consulting
Jenkins CI presentation
Jenkins CI presentation
Jonathan Holloway
DevOps Powerpoint Presentation Slides
DevOps Powerpoint Presentation Slides
SlideTeam
Recomendados
Job descriptions aiesec in Turkey 2015:2016
Job descriptions aiesec in Turkey 2015:2016
Katarzyna Zielosko
APIsecure 2023 - API orchestration: to build resilient applications, Cherish ...
APIsecure 2023 - API orchestration: to build resilient applications, Cherish ...
apidays
Intel Developer Program
Intel Developer Program
Intel® Software
EY Studie: Top 500 FE Unternehmen
EY Studie: Top 500 FE Unternehmen
EY
DevOps 101 - an Introduction to DevOps
DevOps 101 - an Introduction to DevOps
Red Gate Software
Enterprise-architecture and the service-oriented enterprise
Enterprise-architecture and the service-oriented enterprise
Tetradian Consulting
Jenkins CI presentation
Jenkins CI presentation
Jonathan Holloway
DevOps Powerpoint Presentation Slides
DevOps Powerpoint Presentation Slides
SlideTeam
Intro to GitHub Actions
Intro to GitHub Actions
All Things Open
Introduction to DevOps
Introduction to DevOps
Hawkman Academy
Enterprise architecture framework business case
Enterprise architecture framework business case
Alex Antonatos
ESB Overview
ESB Overview
Bahaa Farouk
How to establish Enterprise Architecture in large organisations using TOGAF
How to establish Enterprise Architecture in large organisations using TOGAF
Nemanja Kostic
Introducing DevOps
Introducing DevOps
Nishanth K Hydru
Big data landscape v 3.0 - Matt Turck (FirstMark)
Big data landscape v 3.0 - Matt Turck (FirstMark)
Matt Turck
ITIL vs TOGAF First Round
ITIL vs TOGAF First Round
BITIL.COM
Dev ops != Dev+Ops
Dev ops != Dev+Ops
Shalu Ahuja
What is DevOps? | DevOps Introduction | DevOps Tools | DevOps Tutorial For Be...
What is DevOps? | DevOps Introduction | DevOps Tools | DevOps Tutorial For Be...
Simplilearn
Terraform Code Reviews: Supercharged with Conftest
Terraform Code Reviews: Supercharged with Conftest
Jay Wallace
Devops Devops Devops, at Froscon
Devops Devops Devops, at Froscon
Kris Buytaert
DevRelCon 2022: "Is Product Led Growth (PLG) the “DevOps” of the DevRel World"
DevRelCon 2022: "Is Product Led Growth (PLG) the “DevOps” of the DevRel World"
Daniel Bryant
What does productivity mean to developers
What does productivity mean to developers
Margaret-Anne Storey
Taming technical debt
Taming technical debt
Panji Gautama
Principes de L'intégration Continue
Principes de L'intégration Continue
Xavier Warzee
CONTINUOUS INTEGRATION WITH JENKINS AND GIT
CONTINUOUS INTEGRATION WITH JENKINS AND GIT
Benjamin Lutaaya
DevOps & DevEx
DevOps & DevEx
Ifunga Ndana
Application Value Assessment
Application Value Assessment
Gerry Appeltants
Salesforce Essentials Helsinki 10.5.2017 Innovation Track2
Salesforce Essentials Helsinki 10.5.2017 Innovation Track2
Salesforce Finland
Crafting APIs
Crafting APIs
Tatiana Al-Chueyr
Practical guide to building public APIs
Practical guide to building public APIs
Reda Hmeid MBCS
Mais conteúdo relacionado
Mais procurados
Intro to GitHub Actions
Intro to GitHub Actions
All Things Open
Introduction to DevOps
Introduction to DevOps
Hawkman Academy
Enterprise architecture framework business case
Enterprise architecture framework business case
Alex Antonatos
ESB Overview
ESB Overview
Bahaa Farouk
How to establish Enterprise Architecture in large organisations using TOGAF
How to establish Enterprise Architecture in large organisations using TOGAF
Nemanja Kostic
Introducing DevOps
Introducing DevOps
Nishanth K Hydru
Big data landscape v 3.0 - Matt Turck (FirstMark)
Big data landscape v 3.0 - Matt Turck (FirstMark)
Matt Turck
ITIL vs TOGAF First Round
ITIL vs TOGAF First Round
BITIL.COM
Dev ops != Dev+Ops
Dev ops != Dev+Ops
Shalu Ahuja
What is DevOps? | DevOps Introduction | DevOps Tools | DevOps Tutorial For Be...
What is DevOps? | DevOps Introduction | DevOps Tools | DevOps Tutorial For Be...
Simplilearn
Terraform Code Reviews: Supercharged with Conftest
Terraform Code Reviews: Supercharged with Conftest
Jay Wallace
Devops Devops Devops, at Froscon
Devops Devops Devops, at Froscon
Kris Buytaert
DevRelCon 2022: "Is Product Led Growth (PLG) the “DevOps” of the DevRel World"
DevRelCon 2022: "Is Product Led Growth (PLG) the “DevOps” of the DevRel World"
Daniel Bryant
What does productivity mean to developers
What does productivity mean to developers
Margaret-Anne Storey
Taming technical debt
Taming technical debt
Panji Gautama
Principes de L'intégration Continue
Principes de L'intégration Continue
Xavier Warzee
CONTINUOUS INTEGRATION WITH JENKINS AND GIT
CONTINUOUS INTEGRATION WITH JENKINS AND GIT
Benjamin Lutaaya
DevOps & DevEx
DevOps & DevEx
Ifunga Ndana
Application Value Assessment
Application Value Assessment
Gerry Appeltants
Salesforce Essentials Helsinki 10.5.2017 Innovation Track2
Salesforce Essentials Helsinki 10.5.2017 Innovation Track2
Salesforce Finland
Mais procurados
(20)
Intro to GitHub Actions
Intro to GitHub Actions
Introduction to DevOps
Introduction to DevOps
Enterprise architecture framework business case
Enterprise architecture framework business case
ESB Overview
ESB Overview
How to establish Enterprise Architecture in large organisations using TOGAF
How to establish Enterprise Architecture in large organisations using TOGAF
Introducing DevOps
Introducing DevOps
Big data landscape v 3.0 - Matt Turck (FirstMark)
Big data landscape v 3.0 - Matt Turck (FirstMark)
ITIL vs TOGAF First Round
ITIL vs TOGAF First Round
Dev ops != Dev+Ops
Dev ops != Dev+Ops
What is DevOps? | DevOps Introduction | DevOps Tools | DevOps Tutorial For Be...
What is DevOps? | DevOps Introduction | DevOps Tools | DevOps Tutorial For Be...
Terraform Code Reviews: Supercharged with Conftest
Terraform Code Reviews: Supercharged with Conftest
Devops Devops Devops, at Froscon
Devops Devops Devops, at Froscon
DevRelCon 2022: "Is Product Led Growth (PLG) the “DevOps” of the DevRel World"
DevRelCon 2022: "Is Product Led Growth (PLG) the “DevOps” of the DevRel World"
What does productivity mean to developers
What does productivity mean to developers
Taming technical debt
Taming technical debt
Principes de L'intégration Continue
Principes de L'intégration Continue
CONTINUOUS INTEGRATION WITH JENKINS AND GIT
CONTINUOUS INTEGRATION WITH JENKINS AND GIT
DevOps & DevEx
DevOps & DevEx
Application Value Assessment
Application Value Assessment
Salesforce Essentials Helsinki 10.5.2017 Innovation Track2
Salesforce Essentials Helsinki 10.5.2017 Innovation Track2
Semelhante a Building Self Documenting REST APIs
Crafting APIs
Crafting APIs
Tatiana Al-Chueyr
Practical guide to building public APIs
Practical guide to building public APIs
Reda Hmeid MBCS
Making Sense of Hypermedia APIs – Hype or Reality?
Making Sense of Hypermedia APIs – Hype or Reality?
Akana
REST: The Most Misunderstood Software Architecture Ever
REST: The Most Misunderstood Software Architecture Ever
Martín Soto
Api
Api
Zolzaya Erdenebaatar
Building REST APIs that don't suck for modern day SPAs
Building REST APIs that don't suck for modern day SPAs
Abati Adewale
API Conference 2021
API Conference 2021
José Haro Peralta
Apigility – Lightning Fast API Development - OSSCamp 2014
Apigility – Lightning Fast API Development - OSSCamp 2014
OSSCube
API Documentation.pptx
API Documentation.pptx
RahulCR31
API Documentation.pptx
API Documentation.pptx
RahulCR31
A Practical Guide to Automating End-to-End API Testing
A Practical Guide to Automating End-to-End API Testing
pCloudy
Web API with ASP.NET MVC by Software development company in india
Web API with ASP.NET MVC by Software development company in india
iFour Institute - Sustainable Learning
API Workshop: Deep dive into REST APIs
API Workshop: Deep dive into REST APIs
Tom Johnson
What’s a REST API and why should I care?
What’s a REST API and why should I care?
topher1kenobe
Rest api best practices – comprehensive handbook
Rest api best practices – comprehensive handbook
Katy Slemon
Alfresco Process Services REST API - Alfresco DevCon 2018
Alfresco Process Services REST API - Alfresco DevCon 2018
Dennis Koch
Web Clients for Ruby and What they should be in the future
Web Clients for Ruby and What they should be in the future
Toru Kawamura
Apitesting.pptx
Apitesting.pptx
NamanVerma88
RefCard API Architecture Strategy
RefCard API Architecture Strategy
OCTO Technology
Understanding API Architectures: Web API vs. Minimal API – An In-Depth Compar...
Understanding API Architectures: Web API vs. Minimal API – An In-Depth Compar...
Polyxer Systems
Semelhante a Building Self Documenting REST APIs
(20)
Crafting APIs
Crafting APIs
Practical guide to building public APIs
Practical guide to building public APIs
Making Sense of Hypermedia APIs – Hype or Reality?
Making Sense of Hypermedia APIs – Hype or Reality?
REST: The Most Misunderstood Software Architecture Ever
REST: The Most Misunderstood Software Architecture Ever
Api
Api
Building REST APIs that don't suck for modern day SPAs
Building REST APIs that don't suck for modern day SPAs
API Conference 2021
API Conference 2021
Apigility – Lightning Fast API Development - OSSCamp 2014
Apigility – Lightning Fast API Development - OSSCamp 2014
API Documentation.pptx
API Documentation.pptx
API Documentation.pptx
API Documentation.pptx
A Practical Guide to Automating End-to-End API Testing
A Practical Guide to Automating End-to-End API Testing
Web API with ASP.NET MVC by Software development company in india
Web API with ASP.NET MVC by Software development company in india
API Workshop: Deep dive into REST APIs
API Workshop: Deep dive into REST APIs
What’s a REST API and why should I care?
What’s a REST API and why should I care?
Rest api best practices – comprehensive handbook
Rest api best practices – comprehensive handbook
Alfresco Process Services REST API - Alfresco DevCon 2018
Alfresco Process Services REST API - Alfresco DevCon 2018
Web Clients for Ruby and What they should be in the future
Web Clients for Ruby and What they should be in the future
Apitesting.pptx
Apitesting.pptx
RefCard API Architecture Strategy
RefCard API Architecture Strategy
Understanding API Architectures: Web API vs. Minimal API – An In-Depth Compar...
Understanding API Architectures: Web API vs. Minimal API – An In-Depth Compar...
Mais de Yan Pritzker
Bitcoin not Blockchain
Bitcoin not Blockchain
Yan Pritzker
CTO - Startup to Growth
CTO - Startup to Growth
Yan Pritzker
Outsource Everything
Outsource Everything
Yan Pritzker
Domain Driven Rails
Domain Driven Rails
Yan Pritzker
Pasted image-3237
Pasted image-3237
Yan Pritzker
Pasted image-1795
Pasted image-1795
Yan Pritzker
Pasted image-3237
Pasted image-3237
Yan Pritzker
Pasted image-1795
Pasted image-1795
Yan Pritzker
Pasted image-1706
Pasted image-1706
Yan Pritzker
Building Services on and off Rails
Building Services on and off Rails
Yan Pritzker
Virtualization and Cloud Computing with Elastic Server On Demand
Virtualization and Cloud Computing with Elastic Server On Demand
Yan Pritzker
Mais de Yan Pritzker
(11)
Bitcoin not Blockchain
Bitcoin not Blockchain
CTO - Startup to Growth
CTO - Startup to Growth
Outsource Everything
Outsource Everything
Domain Driven Rails
Domain Driven Rails
Pasted image-3237
Pasted image-3237
Pasted image-1795
Pasted image-1795
Pasted image-3237
Pasted image-3237
Pasted image-1795
Pasted image-1795
Pasted image-1706
Pasted image-1706
Building Services on and off Rails
Building Services on and off Rails
Virtualization and Cloud Computing with Elastic Server On Demand
Virtualization and Cloud Computing with Elastic Server On Demand
Último
Call Girls in Prashant Vihar, Delhi 💯 Call Us 🔝9953056974 🔝 Escort Service
Call Girls in Prashant Vihar, Delhi 💯 Call Us 🔝9953056974 🔝 Escort Service
9953056974 Low Rate Call Girls In Saket, Delhi NCR
Ganeshkhind ! Call Girls Pune - 450+ Call Girl Cash Payment 8005736733 Neha T...
Ganeshkhind ! Call Girls Pune - 450+ Call Girl Cash Payment 8005736733 Neha T...
SUHANI PANDEY
𓀤Call On 7877925207 𓀤 Ahmedguda Call Girls Hot Model With Sexy Bhabi Ready Fo...
𓀤Call On 7877925207 𓀤 Ahmedguda Call Girls Hot Model With Sexy Bhabi Ready Fo...
Neha Pandey
VIP Model Call Girls NIBM ( Pune ) Call ON 8005736733 Starting From 5K to 25K...
VIP Model Call Girls NIBM ( Pune ) Call ON 8005736733 Starting From 5K to 25K...
SUHANI PANDEY
Lucknow ❤CALL GIRL 88759*99948 ❤CALL GIRLS IN Lucknow ESCORT SERVICE❤CALL GIRL
Lucknow ❤CALL GIRL 88759*99948 ❤CALL GIRLS IN Lucknow ESCORT SERVICE❤CALL GIRL
imonikaupta
APNIC Policy Roundup, presented by Sunny Chendi at the 5th ICANN APAC-TWNIC E...
APNIC Policy Roundup, presented by Sunny Chendi at the 5th ICANN APAC-TWNIC E...
APNIC
Russian Call Girls Pune (Adult Only) 8005736733 Escort Service 24x7 Cash Pay...
Russian Call Girls Pune (Adult Only) 8005736733 Escort Service 24x7 Cash Pay...
SUHANI PANDEY
( Pune ) VIP Baner Call Girls 🎗️ 9352988975 Sizzling | Escorts | Girls Are Re...
( Pune ) VIP Baner Call Girls 🎗️ 9352988975 Sizzling | Escorts | Girls Are Re...
nilamkumrai
Sarola * Female Escorts Service in Pune | 8005736733 Independent Escorts & Da...
Sarola * Female Escorts Service in Pune | 8005736733 Independent Escorts & Da...
SUHANI PANDEY
VVIP Pune Call Girls Sinhagad WhatSapp Number 8005736733 With Elite Staff And...
VVIP Pune Call Girls Sinhagad WhatSapp Number 8005736733 With Elite Staff And...
SUHANI PANDEY
Katraj ( Call Girls ) Pune 6297143586 Hot Model With Sexy Bhabi Ready For S...
Katraj ( Call Girls ) Pune 6297143586 Hot Model With Sexy Bhabi Ready For S...
tanu pandey
Pirangut | Call Girls Pune Phone No 8005736733 Elite Escort Service Available...
Pirangut | Call Girls Pune Phone No 8005736733 Elite Escort Service Available...
SUHANI PANDEY
20240509 QFM015 Engineering Leadership Reading List April 2024.pdf
20240509 QFM015 Engineering Leadership Reading List April 2024.pdf
Matthew Sinclair
VIP Call Girls Himatnagar 7001035870 Whatsapp Number, 24/07 Booking
VIP Call Girls Himatnagar 7001035870 Whatsapp Number, 24/07 Booking
dharasingh5698
Microsoft Azure Arc Customer Deck Microsoft
Microsoft Azure Arc Customer Deck Microsoft
AanSulistiyo
20240510 QFM016 Irresponsible AI Reading List April 2024.pdf
20240510 QFM016 Irresponsible AI Reading List April 2024.pdf
Matthew Sinclair
Pune Airport ( Call Girls ) Pune 6297143586 Hot Model With Sexy Bhabi Ready...
Pune Airport ( Call Girls ) Pune 6297143586 Hot Model With Sexy Bhabi Ready...
tanu pandey
Trump Diapers Over Dems t shirts Sweatshirt
Trump Diapers Over Dems t shirts Sweatshirt
rahman018755
➥🔝 7737669865 🔝▻ mehsana Call-girls in Women Seeking Men 🔝mehsana🔝 Escorts...
➥🔝 7737669865 🔝▻ mehsana Call-girls in Women Seeking Men 🔝mehsana🔝 Escorts...
nirzagarg
Call Girls Ludhiana Just Call 98765-12871 Top Class Call Girl Service Available
Call Girls Ludhiana Just Call 98765-12871 Top Class Call Girl Service Available
Seo
Último
(20)
Call Girls in Prashant Vihar, Delhi 💯 Call Us 🔝9953056974 🔝 Escort Service
Call Girls in Prashant Vihar, Delhi 💯 Call Us 🔝9953056974 🔝 Escort Service
Ganeshkhind ! Call Girls Pune - 450+ Call Girl Cash Payment 8005736733 Neha T...
Ganeshkhind ! Call Girls Pune - 450+ Call Girl Cash Payment 8005736733 Neha T...
𓀤Call On 7877925207 𓀤 Ahmedguda Call Girls Hot Model With Sexy Bhabi Ready Fo...
𓀤Call On 7877925207 𓀤 Ahmedguda Call Girls Hot Model With Sexy Bhabi Ready Fo...
VIP Model Call Girls NIBM ( Pune ) Call ON 8005736733 Starting From 5K to 25K...
VIP Model Call Girls NIBM ( Pune ) Call ON 8005736733 Starting From 5K to 25K...
Lucknow ❤CALL GIRL 88759*99948 ❤CALL GIRLS IN Lucknow ESCORT SERVICE❤CALL GIRL
Lucknow ❤CALL GIRL 88759*99948 ❤CALL GIRLS IN Lucknow ESCORT SERVICE❤CALL GIRL
APNIC Policy Roundup, presented by Sunny Chendi at the 5th ICANN APAC-TWNIC E...
APNIC Policy Roundup, presented by Sunny Chendi at the 5th ICANN APAC-TWNIC E...
Russian Call Girls Pune (Adult Only) 8005736733 Escort Service 24x7 Cash Pay...
Russian Call Girls Pune (Adult Only) 8005736733 Escort Service 24x7 Cash Pay...
( Pune ) VIP Baner Call Girls 🎗️ 9352988975 Sizzling | Escorts | Girls Are Re...
( Pune ) VIP Baner Call Girls 🎗️ 9352988975 Sizzling | Escorts | Girls Are Re...
Sarola * Female Escorts Service in Pune | 8005736733 Independent Escorts & Da...
Sarola * Female Escorts Service in Pune | 8005736733 Independent Escorts & Da...
VVIP Pune Call Girls Sinhagad WhatSapp Number 8005736733 With Elite Staff And...
VVIP Pune Call Girls Sinhagad WhatSapp Number 8005736733 With Elite Staff And...
Katraj ( Call Girls ) Pune 6297143586 Hot Model With Sexy Bhabi Ready For S...
Katraj ( Call Girls ) Pune 6297143586 Hot Model With Sexy Bhabi Ready For S...
Pirangut | Call Girls Pune Phone No 8005736733 Elite Escort Service Available...
Pirangut | Call Girls Pune Phone No 8005736733 Elite Escort Service Available...
20240509 QFM015 Engineering Leadership Reading List April 2024.pdf
20240509 QFM015 Engineering Leadership Reading List April 2024.pdf
VIP Call Girls Himatnagar 7001035870 Whatsapp Number, 24/07 Booking
VIP Call Girls Himatnagar 7001035870 Whatsapp Number, 24/07 Booking
Microsoft Azure Arc Customer Deck Microsoft
Microsoft Azure Arc Customer Deck Microsoft
20240510 QFM016 Irresponsible AI Reading List April 2024.pdf
20240510 QFM016 Irresponsible AI Reading List April 2024.pdf
Pune Airport ( Call Girls ) Pune 6297143586 Hot Model With Sexy Bhabi Ready...
Pune Airport ( Call Girls ) Pune 6297143586 Hot Model With Sexy Bhabi Ready...
Trump Diapers Over Dems t shirts Sweatshirt
Trump Diapers Over Dems t shirts Sweatshirt
➥🔝 7737669865 🔝▻ mehsana Call-girls in Women Seeking Men 🔝mehsana🔝 Escorts...
➥🔝 7737669865 🔝▻ mehsana Call-girls in Women Seeking Men 🔝mehsana🔝 Escorts...
Call Girls Ludhiana Just Call 98765-12871 Top Class Call Girl Service Available
Call Girls Ludhiana Just Call 98765-12871 Top Class Call Girl Service Available
Building Self Documenting REST APIs
1.
Self-Documenting APIs @skwp @reverbdotcom
2.
3.
What Makes a Good
API?
4.
Discoverable
5.
Self Documenting
6.
Standardized
7.
Discoverability
8.
Discoverability What can I
do with it?
9.
If the engine
of application state (and hence the API) is not being driven by hypertext, then it cannot be RESTful and cannot be a REST API. Period.
10.
http://martinfowler.com/articles/richardsonMaturityModel.html
11.
Hypermedia as the
Engine of Application State HATEOAS
12.
What Happens When
I GET reverb.com/api?
13.
What Happens When
I GET yahoo.com?
14.
curl https://reverb.com/api
15.
GET product._links.buy
16.
17.
18.
Evolvability
19.
Self-Documenting
20.
Self-Documenting How can I
do what I want to do?
21.
Minimize Documentation Drift
22.
Generate Docs, Clients,
even Servers from Code
23.
24.
25.
Standardized
26.
Standardized How is it
similar to other APIs?
27.
Simplicity Increases Likelihood of
Adoption
28.
Fewer Constructs is Simpler
29.
Siren • jsonapi.org
• HAL
30.
Siren • jsonapi.org
• HAL
31.
Siren • jsonapi.org
• HAL
32.
Winner: HAL http://stateless.co/hal_specification.html
33.
BONUS - Baked
into Roar
34.
Discoverable ✓HATEOAS ✓HAL Links ✓Grape+Roar
35.
Self Documenting ✓Swagger ✓Grape-Swagger ✓Swagger-UI
36.
Standardized ✓Swagger ✓HAL ✓REST
37.
Resources http://swagger.io/ https://github.com/swagger-api/swagger-spec http://api.opensupporter.org/hb2/browser.html#/api/v1 http://stateless.co/hal_specification.html https://github.com/swagger-api/swagger-ui http://roy.gbiv.com/untangled/2008/rest-apis-must-be- hypertext-driven @skwp @reverbdotcom https://github.com/swagger-api/swagger-codegen
Baixar agora