vendor neutral apis - fhir devdays...specification for providing technical metadata for rest apis....

37
FHIR® is the registered trademark of HL7 and is used with the permission of HL7. The Flame Design mark is the registered trademark of HL7 and is used with the permission of HL7. Amsterdam, 15-17 November | @fhir_furore | #fhirdevdays17 | www.fhirdevdays.com VENDOR NEUTRAL APIs Mo Alkady, Hart

Upload: others

Post on 22-May-2020

5 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

FHIR® is the registered trademark of HL7 and is used with the permission of HL7. The Flame Design mark is the registered trademark of HL7 and is used with the permission of HL7.

Amsterdam, 15-17 November | @fhir_furore | #fhirdevdays17 | www.fhirdevdays.com

VENDOR NEUTRAL APIs

Mo Alkady, Hart

Page 2: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010
Page 3: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010
Page 4: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010
Page 5: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010
Page 6: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

17,000+ APIs available today

Page 7: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010
Page 8: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010
Page 9: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Developers today face incomplete API documentation, random documentation and even lacking

documentation.

Page 10: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010
Page 11: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010
Page 12: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Building a vendor-neutral, portable and open specification for providing technical metadata for REST

APIs.

Page 13: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010
Page 14: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Imagine being able to understand any API by

just reading the documentation.

Page 15: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010
Page 16: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

2010Tony Tam @Wordnik founded Swagger

Q1 2015Swagger acquired by SmartBear

Q3 2015 Linux Foundation Workgroup Forms

Q4 2015 Swagger renamed OpenAPI Specification

2010 - 2014Development, Growth, Adoption, Tooling, Community

Page 17: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010
Page 18: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Swagger is the most popular API framework with over 100k visitors every

month and 11k+ downloadsper day

Page 19: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010
Page 20: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Programmers are lazy efficient

Page 21: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Let’s put the docs in the

code.

Page 22: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Language Neutral

& Machine Readable Format

APIs can be defined in

JSON or YAML

API-First & Code-First

Development

Powerful Extension

Mechanism

Comprehensive Tooling Support (core, UI, codegen, editor)

Page 23: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Let’s just code!

Page 24: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

What Spec? Spec Generates

Code

Spec as

Code

Code is

Spec

Page 25: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Build docs by processing

JSON/YAML API Spec

The API Spec can be returned from static source or from the

running API

Page 26: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Let’s start with the API

Spec!

Page 27: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Commitment to Remain

OpenPortable

Vendor Neutral

Strong Independent Sponsorship

CommunitySimple & Pragmatic

Superior Tooling Best Industry Support

Page 28: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

There are of course some challenges, that are both internal and external

Page 29: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

There are of course some challenges, that are both internal and external

Page 30: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Seeing custom APIs as competitive edge

Page 31: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Lack of investment in open source

Page 32: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Seeing APIs as a secondary need to their software

Page 33: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

We can’t make everyone happy

Page 34: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

APIs are getting more and more complex

Page 35: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Framework or specification?

Page 36: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

+

Page 37: VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs. Imagine being able to understand any API by just reading the documentation. 2010

Website: https://openapis.org/

Spec: https://github.com/oai

Follow: @OpenApiSpec