Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Effective API Governance: Lessons Learnt
Search
Alvaro Navarro
October 10, 2019
Programming
0
3.1k
Effective API Governance: Lessons Learnt
Talk delivered at API the Docs Amsterdam 2019
Alvaro Navarro
October 10, 2019
Tweet
Share
More Decks by Alvaro Navarro
See All by Alvaro Navarro
Baking a great DX
alnacle
0
130
Designing APIs Like You'd Design Your House
alnacle
0
110
Build your first Spotify App
alnacle
0
19
How to use your API Gateway as Developer Relations Tool
alnacle
0
40
Building awesome SDKs for your APIs: Best Practices
alnacle
0
86
DevRel as Professional Career
alnacle
0
170
Building a partnership that scales through APIs
alnacle
0
100
The Journey of an OpenAPI platform
alnacle
0
140
Delivering great Developer Experience with Apigee
alnacle
0
130
Other Decks in Programming
See All in Programming
モジュラモノリス、その前に / Modular monolith, before that
euglena1215
8
750
Jakarta EE as Seen Trough the Lens of the ASF
ivargrimstad
0
860
tsconfig.jsonの最近の新機能 ファイルパス編
uhyo
7
1.9k
Програмиране с Rust, ФМИ, 2024
nikolads
0
120
CSC305 Lecture 09
javiergs
PRO
0
120
Повторное использование кода в ML: почему ML-пайплайны могут помочь?
lamodatech
0
400
Piniaの現状と今後
waka292
2
520
急速に利用拡大を続ける飲食店向けサービスで 店内端末同士のローカル通信を追加設定なしで実現した話
whatasoda
0
140
tc39 x jsconf.jp Panel Discussion 2024
yosuke_furukawa
PRO
0
110
GPU Hash Table | レイトレ合宿10
yknishidate
0
330
いかにして不足・不整合なくデータ移行したか
tjmtmmnk
1
910
文化が生産性を作る
jimpei
3
630
Featured
See All Featured
The Success of Rails: Ensuring Growth for the Next 100 Years
eileencodes
43
6.6k
Bash Introduction
62gerente
608
210k
Optimizing for Happiness
mojombo
376
69k
Let's Do A Bunch of Simple Stuff to Make Websites Faster
chriscoyier
504
140k
The Cost Of JavaScript in 2023
addyosmani
44
5.9k
Principles of Awesome APIs and How to Build Them.
keavy
126
17k
Building Adaptive Systems
keathley
38
2.2k
How to train your dragon (web standard)
notwaldorf
88
5.6k
Designing Experiences People Love
moore
138
23k
Testing 201, or: Great Expectations
jmmastey
38
7k
Music & Morning Musume
bryan
46
6.1k
Designing for Performance
lara
604
68k
Transcript
© 2016 Amadeus IT Group and its affiliates and subsidiaries
Effective API Governance Lessons Learnt Alvaro Navarro Amsterdam, 10th October 2019
Once upon a time
Trip Purpose Prediction API Once upon a time
Once upon a time Returns the forecast purpose of a
trip Business or Leisure based on a search criteria.
GET /flights/predictions/purpose Once upon a time
origin : MAD destination : AMS departure : 20191012 return
: 20191015 Once upon a time
{ "result": { "prediction" : "BUSINESS", "probability": 0.751 } }
Once upon a time
Accept: application/vnd.amadeus.v1.full+json Once upon a time
Once upon a time
You need your API validated by the API Governance Board!
Once upon a time
Once upon a time
Once upon a time
Once upon a time
Once upon a time
Once upon a time
Hello World @alnacle
Motivation More than 20 years working with APIs ◦ EDIFACT
◦ SOAP/XML ◦ REST/JSON ◦ Protobuf ◦ GraphQL
Motivation Many people designing and implementing APIs
Motivation Difficult to reuse across backends
Motivation We need to regulate this!
What is the API Governance?
What is the API Governance? Community of API Designers and
Developers
What is the API Governance? Owners of guidelines, data dictionaries
and processes
What is the API Governance? Support
In Amadeus we introduced the HAPPY principle
What is the API Governance? Homogeneous
What is the API Governance? Homogeneous Active
What is the API Governance? Homogeneous Active Pragmatic
What is the API Governance? Homogeneous Active Pragmatic Positive
What is the API Governance? Homogeneous Active Pragmatic Positive Young
Why API Governance?
Why API Governance? As API Producer
Why API Governance? Design Guidelines and Standardization
Why API Governance? Design Guidelines and Standardization ❏ Errors ❏
Endpoint/parameters naming ❏ Improvements ❏ Data Dictionaries ❏ Versioning
Why API Governance? Using URLs http://api.amadeus.com/v1/flight-search http://api.amadeus.com/2018/flight-search http://api.amadeus.com/2018/02/flight-search Using HTTP
Header Accept: application/vnd.amadeus.v1 Accept-Version: 1 Using a Query parameter $ curl http://api.amadeus.com/flight-search?version=1
Why API Governance? As API Consumer
Why API Governance? Better API integration and consistency
Why API Governance? import amadeus client = amadeus.Client() response =
client.shopping.flight_destinations.get(origin = 'AMS', maxPrice = '500')
How do we make it work?
How do we make it work? Technical discussions: Decision Logs
How do we make it work? API submissions: Review Cards
How do we make it work?
How do we make it work? Under Construction In Progress
Pending Validated Review Process ( 1 week ) 1 to 4 weeks ❏ Validated Review Card ❏ Documentation ❏ Swagger Designer
Lessons Learnt
Lessons Learnt Tools are your friends! ◦ Designing ◦ Documenting
◦ Testing
Lessons Learnt Be an advocate and spread the word!
Lessons Learnt It's not a control entity ! Democratic approach
when designing APIs
Lessons Learnt It is a place to speak and share
knowledge
Thanks! developers.amadeus.com