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
Hospital management system in java
Hospital management system in java
Varun Yadav
Fundamental classes in java
Fundamental classes in java
Garuda Trainings
hospital management System
hospital management System
sabin kafle
Defining Kanban View in Odoo15 | Advanced Views
Defining Kanban View in Odoo15 | Advanced Views
Celine George
Moodle kurulumu
Moodle kurulumu
OYS_MOODLE
Interpreter
Interpreter
IGZ Software house
Defining Gantt View in Odoo 15
Defining Gantt View in Odoo 15
Celine George
Moodle Tutorials
Moodle Tutorials
Carole McCulloch
Recomendados
Hospital management system in java
Hospital management system in java
Varun Yadav
Fundamental classes in java
Fundamental classes in java
Garuda Trainings
hospital management System
hospital management System
sabin kafle
Defining Kanban View in Odoo15 | Advanced Views
Defining Kanban View in Odoo15 | Advanced Views
Celine George
Moodle kurulumu
Moodle kurulumu
OYS_MOODLE
Interpreter
Interpreter
IGZ Software house
Defining Gantt View in Odoo 15
Defining Gantt View in Odoo 15
Celine George
Moodle Tutorials
Moodle Tutorials
Carole McCulloch
Lecture 5 sending and receiving e-mail
Lecture 5 sending and receiving e-mail
Maxwell Musonda
Boolean+logic
Boolean+logic
Bilal Maqbool ツ
Email & internet
Email & internet
smartware
Feasibility Study of Hospital Management System
Feasibility Study of Hospital Management System
Neelam Priya
Methods of connecting internet
Methods of connecting internet
Tittu Anna
Database software
Database software
JahidHussain13
Object Oriented Programming : A Brief History and its significance
Object Oriented Programming : A Brief History and its significance
Gajesh Bhat
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
Mais conteúdo relacionado
Mais procurados
Lecture 5 sending and receiving e-mail
Lecture 5 sending and receiving e-mail
Maxwell Musonda
Boolean+logic
Boolean+logic
Bilal Maqbool ツ
Email & internet
Email & internet
smartware
Feasibility Study of Hospital Management System
Feasibility Study of Hospital Management System
Neelam Priya
Methods of connecting internet
Methods of connecting internet
Tittu Anna
Database software
Database software
JahidHussain13
Object Oriented Programming : A Brief History and its significance
Object Oriented Programming : A Brief History and its significance
Gajesh Bhat
Mais procurados
(7)
Lecture 5 sending and receiving e-mail
Lecture 5 sending and receiving e-mail
Boolean+logic
Boolean+logic
Email & internet
Email & internet
Feasibility Study of Hospital Management System
Feasibility Study of Hospital Management System
Methods of connecting internet
Methods of connecting internet
Database software
Database software
Object Oriented Programming : A Brief History and its significance
Object Oriented Programming : A Brief History and its significance
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
TRENDS Enabling and inhibiting dimensions.pptx
TRENDS Enabling and inhibiting dimensions.pptx
AndrieCagasanAkio
办理多伦多大学毕业证成绩单|购买加拿大UTSG文凭证书
办理多伦多大学毕业证成绩单|购买加拿大UTSG文凭证书
zdzoqco
Top 10 Interactive Website Design Trends in 2024.pptx
Top 10 Interactive Website Design Trends in 2024.pptx
Dyna Gilbert
ETHICAL HACKING dddddddddddddddfnandni.pptx
ETHICAL HACKING dddddddddddddddfnandni.pptx
NIMMANAGANTI RAMAKRISHNA
Unidad 4 – Redes de ordenadores (en inglés).pptx
Unidad 4 – Redes de ordenadores (en inglés).pptx
mibuzondetrabajo
『澳洲文凭』买詹姆士库克大学毕业证书成绩单办理澳洲JCU文凭学位证书
『澳洲文凭』买詹姆士库克大学毕业证书成绩单办理澳洲JCU文凭学位证书
rnrncn29
SCM Symposium PPT Format Customer loyalty is predi
SCM Symposium PPT Format Customer loyalty is predi
eusebiomeyer
IP addressing and IPv6, presented by Paul Wilson at IETF 119
IP addressing and IPv6, presented by Paul Wilson at IETF 119
APNIC
Film cover research (1).pptxsdasdasdasdasdasa
Film cover research (1).pptxsdasdasdasdasdasa
494f574xmv
『澳洲文凭』买拉筹伯大学毕业证书成绩单办理澳洲LTU文凭学位证书
『澳洲文凭』买拉筹伯大学毕业证书成绩单办理澳洲LTU文凭学位证书
rnrncn29
Company Snapshot Theme for Business by Slidesgo.pptx
Company Snapshot Theme for Business by Slidesgo.pptx
Mario
Último
(11)
TRENDS Enabling and inhibiting dimensions.pptx
TRENDS Enabling and inhibiting dimensions.pptx
办理多伦多大学毕业证成绩单|购买加拿大UTSG文凭证书
办理多伦多大学毕业证成绩单|购买加拿大UTSG文凭证书
Top 10 Interactive Website Design Trends in 2024.pptx
Top 10 Interactive Website Design Trends in 2024.pptx
ETHICAL HACKING dddddddddddddddfnandni.pptx
ETHICAL HACKING dddddddddddddddfnandni.pptx
Unidad 4 – Redes de ordenadores (en inglés).pptx
Unidad 4 – Redes de ordenadores (en inglés).pptx
『澳洲文凭』买詹姆士库克大学毕业证书成绩单办理澳洲JCU文凭学位证书
『澳洲文凭』买詹姆士库克大学毕业证书成绩单办理澳洲JCU文凭学位证书
SCM Symposium PPT Format Customer loyalty is predi
SCM Symposium PPT Format Customer loyalty is predi
IP addressing and IPv6, presented by Paul Wilson at IETF 119
IP addressing and IPv6, presented by Paul Wilson at IETF 119
Film cover research (1).pptxsdasdasdasdasdasa
Film cover research (1).pptxsdasdasdasdasdasa
『澳洲文凭』买拉筹伯大学毕业证书成绩单办理澳洲LTU文凭学位证书
『澳洲文凭』买拉筹伯大学毕业证书成绩单办理澳洲LTU文凭学位证书
Company Snapshot Theme for Business by Slidesgo.pptx
Company Snapshot Theme for Business by Slidesgo.pptx
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