Effective API Governance: Lessons Learnt

by Alvaro Navarro

Slide 1

Slide 1 text

Slide 2

Slide 2 text

Once upon a time

Slide 3

Slide 3 text

Trip Purpose Prediction API Once upon a time

Slide 4

Slide 4 text

Once upon a time Returns the forecast purpose of a trip Business or Leisure based on a search criteria.

Slide 5

Slide 5 text

GET /flights/predictions/purpose Once upon a time

Slide 6

Slide 6 text

origin : MAD destination : AMS departure : 20191012 return : 20191015 Once upon a time

Slide 7

Slide 7 text

{ "result": { "prediction" : "BUSINESS", "probability": 0.751 } } Once upon a time

Slide 8

Slide 8 text

Accept: application/vnd.amadeus.v1.full+json Once upon a time

Slide 9

Slide 9 text

Once upon a time

Slide 10

Slide 10 text

You need your API validated by the API Governance Board! Once upon a time

Slide 11

Slide 11 text

Once upon a time

Slide 12

Slide 12 text

Once upon a time

Slide 13

Slide 13 text

Once upon a time

Slide 14

Slide 14 text

Once upon a time

Slide 15

Slide 15 text

Once upon a time

Slide 16

Slide 16 text

Hello World @alnacle

Slide 17

Slide 17 text

Motivation More than 20 years working with APIs ○ EDIFACT ○ SOAP/XML ○ REST/JSON ○ Protobuf ○ GraphQL

Slide 18

Slide 18 text

Motivation Many people designing and implementing APIs

Slide 19

Slide 19 text

Motivation Diﬃcult to reuse across backends

Slide 20

Slide 20 text

Motivation We need to regulate this!

Slide 21

Slide 21 text

What is the API Governance?

Slide 22

Slide 22 text

What is the API Governance? Community of API Designers and Developers

Slide 23

Slide 23 text

What is the API Governance? Owners of guidelines, data dictionaries and processes

Slide 24

Slide 24 text

What is the API Governance? Support

Slide 25

Slide 25 text

In Amadeus we introduced the HAPPY principle

Slide 26

Slide 26 text

What is the API Governance? Homogeneous

Slide 27

Slide 27 text

What is the API Governance? Homogeneous Active

Slide 28

Slide 28 text

What is the API Governance? Homogeneous Active Pragmatic

Slide 29

Slide 29 text

What is the API Governance? Homogeneous Active Pragmatic Positive

Slide 30

Slide 30 text

What is the API Governance? Homogeneous Active Pragmatic Positive Young

Slide 31

Slide 31 text

Why API Governance?

Slide 32

Slide 32 text

Why API Governance? As API Producer

Slide 33

Slide 33 text

Why API Governance? Design Guidelines and Standardization

Slide 34

Slide 34 text

Why API Governance? Design Guidelines and Standardization ❏ Errors ❏ Endpoint/parameters naming ❏ Improvements ❏ Data Dictionaries ❏ Versioning

Slide 35

Slide 35 text

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

Slide 36

Slide 36 text

Why API Governance? As API Consumer

Slide 37

Slide 37 text

Why API Governance? Better API integration and consistency

Slide 38

Slide 38 text

Why API Governance? import amadeus client = amadeus.Client() response = client.shopping.flight_destinations.get(origin = 'AMS', maxPrice = '500')

Slide 39

Slide 39 text

How do we make it work?

Slide 40

Slide 40 text

How do we make it work? Technical discussions: Decision Logs

Slide 41

Slide 41 text

How do we make it work? API submissions: Review Cards

Slide 42

Slide 42 text

How do we make it work?

Slide 43

Slide 43 text

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

Slide 44

Slide 44 text

Lessons Learnt

Slide 45

Slide 45 text

Lessons Learnt Tools are your friends! ○ Designing ○ Documenting ○ Testing

Slide 46

Slide 46 text

Lessons Learnt Be an advocate and spread the word!

Slide 47

Slide 47 text

Lessons Learnt It's not a control entity ! Democratic approach when designing APIs