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
OpenAPI and Java - Portland - 2019-12-10
Search
sullis
December 10, 2019
Programming
0
190
OpenAPI and Java - Portland - 2019-12-10
Portland Java User Group
Portland Oregon
December 10, 2019
#openapi
#java
sullis
December 10, 2019
Tweet
Share
More Decks by sullis
See All by sullis
Netty Chicago Java User Group 2024-04-17
sullis
0
230
Java 21 - Portland Java User Group 2023-10-24
sullis
0
230
Microbenchmarking with JMH - Portland 2023-03-14
sullis
0
100
Code generation on the Java VM 2022-04-19
sullis
0
83
Mockito 2022-01-25
sullis
0
150
GitHub Actions 2021-12-16
sullis
0
28
Apache Struts and the Equifax data breach 2021-06-03
sullis
0
46
Guardrail State of the Union 2021-04-13
sullis
0
280
Guardrail: State of the Union 2021-03-18
sullis
0
140
Other Decks in Programming
See All in Programming
ペパボOpenTelemetry革命
pyama86
2
200
dbtのドメイン分割による データ基盤の改善とDigdagとの連携
sakama
0
490
Introducing Kotlin Multiplatform in an existing mobile app - Workshop Edition | AndroidMakers Paris
prof18
0
170
CDKコントリビュートの最初の壁を越えよう! -簡単issueの見つけ方-
badmintoncryer
3
390
AmperとFleetを使ったAndroidアプリ
yoppie
0
290
Komplexe Oberflächen mit SVG und der Web Animation API
joergneumann
0
690
GitLab CI/CD で C#/WPFアプリケーションのテストとインストーラーのビルド・デプロイを自動化する
hacarus
0
540
R言語の環境構築と基礎 Tokyo.R 112
bob3bob3
0
290
Scalable Customer Journey Orchestration (CJO)
lewuathe
0
470
使ってみよう Azure AI Document Intelligence
kosmosebi
2
380
株式会社ゼネテック
genetec
0
110
TypeScriptのパフォーマンス改善
yajihum
9
4.3k
Featured
See All Featured
Distributed Sagas: A Protocol for Coordinating Microservices
caitiem20
323
20k
Designing the Hi-DPI Web
ddemaree
276
33k
Typedesign – Prime Four
hannesfritz
36
2.1k
How to Ace a Technical Interview
jacobian
273
22k
Java REST API Framework Comparison - PWX 2021
mraible
PRO
18
7k
Dealing with People You Can't Stand - Big Design 2015
cassininazir
358
22k
What the flash - Photography Introduction
edds
64
11k
Teambox: Starting and Learning
jrom
128
8.4k
How to train your dragon (web standard)
notwaldorf
75
5.2k
Product Roadmaps are Hard
iamctodd
45
9.8k
The MySQL Ecosystem @ GitHub 2015
samlambert
244
12k
[RailsConf 2023 Opening Keynote] The Magic of Rails
eileencodes
14
8.4k
Transcript
OpenAPI and Java Sean Sullivan Portland Java User Group December
10, 2019
About me software engineer Portland Oregon Java Scala
Agenda OpenAPI Real world examples Java tools and libraries API
guidelines
OpenAPI
OpenAPI is a specification for describing API’s
API specifications
WSDL (SOAP) WADL (REST)
Swagger (REST) OpenAPI (REST)
https://en.wikipedia.org/wiki/OpenAPI_Specification
REST API’s
API Driven Development
“API first”
source: Adobe Tech Blog June 2017
Code first vs API schema first
JSON or YAML
Real world examples
Case Study: stripe.com OpenAPI
https://github.com/stripe/openapi
https://github.com/stripe/openapi
Case Study: squareup.com OpenAPI
https://github.com/square/connect-api-specification
Case Study: Kubernetes OpenAPI
https://github.com/kubernetes/kubernetes/tree/master/api/openapi-spec
https://github.com/kubernetes-client/java Kubernetes Java Client
https://github.com/kubernetes-client/java Kubernetes Java Client code generation
Case Study: Microsoft Azure OpenAPI
https://github.com/Azure/azure-rest-api-specs azure-rest-api-specs
Case Study: Amazon EventBridge OpenAPI
https://docs.aws.amazon.com/eventbridge Amazon EventBridge “EventBridge is a serverless event bus service
that makes it easy to connect your applications with data from a variety of sources”
https://docs.aws.amazon.com/eventbridge EventBridge Schema Registry Schemas are defined using JSON files,
using the OpenAPI specification
https://www.tbray.org/ongoing/When/201x/2019/12/02/Strongly-Typed-Events Strongly typed events
Java tools and libraries
Swagger libraries swagger-core swagger-parser swagger-codegen swagger-inflector
https://github.com/swagger-api/swagger-parser Swagger parser
pom.xml <dependency> <groupId>io.swagger.parser.v3</groupId> <artifactId>swagger-parser</artifactId> <version>2.0.16</version> </dependency> Swagger parser
https://github.com/swagger-api/swagger-parser import io.swagger.v3.parser.OpenAPIV3Parser; import io.swagger.v3.oas.models.OpenAPI; String url = “http://petstore.swagger.io/v3/openapi.json”; OpenAPI
openAPI = new OpenAPIV3Parser().read(url); Swagger parser
https://github.com/swagger-api/swagger-parser Swagger parser Pull Request #1271
ObjectMapperFactory.java return new JsonFactoryBuilder() .enable(StreamReadFeature.STRICT_DUPLICATE_DETECTION) .build(); Swagger parser Pull Request
#1271
Code generators Guardrail openapi-generator swagger-codegen AutoRest
Guardrail project
https://guardrail.dev/ Guardrail
https://github.com/twilio/guardrail Guardrail
https://github.com/twilio/guardrail Guardrail: Scala ScalaMeta
https://github.com/twilio/guardrail Guardrail: Java JavaParser
Guardrail example
guardrail-maven-plugin <plugin> <groupId>com.twilio</groupId> <artifactId>guardrail-maven-plugin_2.12</artifactId> <version>0.54.5</version> <executions> … </executions> </plugin>
guardrail-maven-plugin <configuration> <language>java</language> <kind>client</kind> <framework>dropwizard</framework> <specPath>${project.basedir}/src/main/openapi/petstore.json</specPath> <packageName>com.example.clients.petstore</packageName> </configuration> Java client
guardrail-maven-plugin
openapi-generator project
openapi-generator
openapi-generator
openapi-generator
REST API guidelines
https://github.com/microsoft/api-guidelines
https://www.infoq.com/news/2016/07/microsoft-rest-api/ July 2016
https://cloud.google.com/apis/design/
https://github.com/zalando/restful-api-guidelines
https://github.com/paypal/api-standards/blob/master/api-style-guide.md
Final thoughts use OpenAPI to define REST API’s adopt “API
First” approach use a code generator to generate client libraries contribute to open source projects
The End