VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs....
Transcript of VENDOR NEUTRAL APIs - FHIR DevDays...specification for providing technical metadata for REST APIs....
![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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/1.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/2.jpg)
![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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/3.jpg)
![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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/4.jpg)
![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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/5.jpg)
![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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/6.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/7.jpg)
![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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/8.jpg)
![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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/9.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/10.jpg)
![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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/11.jpg)
![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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/12.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/13.jpg)
![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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/14.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/15.jpg)
![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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/16.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/17.jpg)
![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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/18.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/19.jpg)
![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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/20.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/21.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/22.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/23.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/24.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/25.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/26.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/27.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/28.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/29.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/30.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/31.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/32.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/33.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/34.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/35.jpg)
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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/36.jpg)
+
![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](https://reader030.fdocuments.us/reader030/viewer/2022041017/5ec9ab455cc3f919ea3330fd/html5/thumbnails/37.jpg)
Website: https://openapis.org/
Spec: https://github.com/oai
Follow: @OpenApiSpec