SlideShare a Scribd company logo

Api design and prototype

Download as PPTX, PDF
D
DonghuKIM2

The document discusses the importance of API design, highlighting the API-first design paradigm and its cost-effectiveness in fixing software defects. It includes hands-on preparation instructions for creating APIs and emphasizes the significance of proper documentation and prototyping. Additionally, it provides links and resources for further learning about API design methodologies.

Technology
Related topics:
API Gateway
1 of 50
Downloaded 16 times
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1 th 김동후 (Oracle Korea) API Design and Prototype 2019.04.20 10 th Oracle Developer Meetup
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 22 https://medium.com/better-practices/the-ultimate-api-publishers-guide-be74a2692326
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | 3 How to Design a Good API and Why it Matters 조슈아 블로치 소프트웨어 아키텍처 Effective Java의 저자Public APIs, like diamonds, are forever. You have one chance to get it right so give it your best.
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 44https://www.programmableweb.com/api-university/understanding-api-first-design
4-5배제품 출시 전 발생한 오류에 대한 해결 비용 100배제품 출시 후 유지보수 단계에서 확인된 오류에 대한 최대 해결 비용 5Copyright © 2018, Oracle and/or its affiliates. All rights reserved. API Design이 왜 중요한가? API-First design is a paradigm shift Relative Costs to Fix Software Defects (Source: IBM Systems Sciences Institute)
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | API First Design & Prototype Process Confidential – Oracle Internal/Restricted/Highly Restricted 66
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | API First Design Confidential – Oracle Internal/Restricted/Highly Restricted 77
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 88
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 99 https://smartbear.com/resources/ebooks/the-state-of-api-2019-report/ The State of API2019Report
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Swagger, RAML, API Blueprint Confidential – Oracle Internal/Restricted/Highly Restricted 1010
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | API Documentation Confidential – Oracle Internal/Restricted/Highly Restricted 1111
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1212 API Blueprint 는 API Design First 접근을 위한 가장 적합한 방법
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1313 https://apiblueprint.org/
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1414 API Name and metadata
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1515 Resource Groups
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1616 Resource
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1717 Actions Resource URI URI Template or Query Parameter {?param1, param2…} Path Parameter {param1}
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1818 Request > Parameters + key : 샘플 값 (type, optional/required) - 설명
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1919 Request > Headers/Body Content-Type 지정 (보통 PUT/POST 에서 JSON 형식으로 넘길 경우 지정) Header 와 Header Key / Value 정의 PUT/POST 에서 JSON으로 데이터 전달할 때 JSON 형식의 샘플로 정의
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2020 Response > Headers/Body Content-Type 지정 (JSON 형식으로 응답을 받는 경우) Header 와 Header Key / Value 정의 JSON 형식 응답을 받는 경우 JSON 형식의 샘플로 정의
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2121 Response Without a Body
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2222 Attributes (Markdown Syntax Objection Notation) 각 속성은 Parameters 지정과 동일 https://github.com/apiaryio/mson/blob/master/MSON%20Specification.md Included MoviePeopleMeta
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2323 API Documentation Mock API Url
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2424 API Blueprint Editors
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2525 Apiary
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2626 Vscode-apielements
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2727 API Prototype
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2828 API Prototype with API Gateway 프로토타입 UI • API Key, OAuth, Basic Auth • 트래픽 제어 • 단일 엔드 포인트 • 모니터링 • 로그 API Management & Gateway RESTful Service Resource RESTful Service Resource RESTful Service Resource RESTful Service Resource
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2929 API Prototype with API Gateway API 디자인 설계 프로토타입 UI API Mocking • API Key, OAuth, Basic Auth • 트래픽 제어 • 단일 엔드 포인트 • 모니터링 • 로그 API Management & Gateway
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3030 API First Design & Prototype Hands-on 실습을 위한 준비 사항 • 깃헙 (https://github.com) 계정 – Apiary 계정을 만들기 위해서 필요 • Nodejs 설치 필요 • https://nodejs.org/ko/download/current/ • UI 프로토타입을 위해서 Oracle JET 설치를 위해 필요 (가급적 최신 버전) • https://github.com/MangDan/meetup-190420-api 다운로드해서 압축 해제
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3131 API First Design Hands-on https://github.com/MangDan/meetup-190420-api
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3232 API First Design Hands-on https://github.com/MangDan/meetup-190420-api
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3333 API First Design Hands-on https://github.com/MangDan/meetup-190420-api 10 : ## 영화 정보 리소스 [/api/search/v1/movies] 12 : ### 영화 조회 [GET /api/search/v1/movies{?title}] 21 : + Parameters 22 : + title : 대부 (string, optional) – 제목 69 : ### 영화 상세 조회 [GET /api/search/v1/movies/{id}] tab
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3434 API First Design Hands-on https://github.com/MangDan/meetup-190420-api 133 : # Data Structures 135 : ## MoviePeople (object) 136 : + Include MoviePeopleMeta 137 : + filmography : 쇼생크 탈출 (string, optional) - 필모그래피 139 : ## MoviePeopleMeta (object) 140 : + id : 10084614 (number, required) - 아이디 141 : + name : 프랭크 다라본트 (string, required) – 이름 142 : + role : 감독 (string, optional) - 역할 타이핑이 어려우신 분들은 1.3. API Blueprint 완성된 문서에서 복사해서 붙여넣기 하셔도 됩니다.
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3535 API First Design Hands-on https://github.com/MangDan/meetup-190420-api 116 : + Attributes (array[MoviePeopleMeta]) 131 : + Attributes (MoviePeople) tab tab 여기까지 못 따라 오신 분들은 1.3. API Blueprint 완성된 문서 내용을 붙여넣기 하셔도 됩니다.
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3636 API First Design Hands-on https://github.com/MangDan/meetup-190420-api
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3737 API First Design Hands-on https://github.com/MangDan/meetup-190420-api
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3838 API First Design Hands-on https://github.com/MangDan/meetup-190420-api
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3939 API First Design Hands-on https://github.com/MangDan/meetup-190420-api
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4040 API First Design Hands-on https://github.com/MangDan/meetup-190420-api UI Prototype을 위해서 Mock 서버의 호스트 정보를 확인합니다. e.g.) http://private-df8a0-api722.apiary-mock.com
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4141 API Prototype Hands-on https://github.com/MangDan/meetup-190420-api API 디자인 설계 • CORS • api_key API Management & Gateway API Mocking 두개의 보안 정책 적용
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4242 API Prototype Hands-on https://github.com/MangDan/meetup-190420-api API 게이트웨이 배포 http://132.145.161.244:8011/api/search/v1
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4343 API Prototype Hands-on https://github.com/MangDan/meetup-190420-api API 디자인 설계 API Mocking • CORS • api_key API Management & Gateway http://132.145.161.244:8011/api/search/v1 endpoint
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4444 API Prototype Hands-on https://github.com/MangDan/meetup-190420-api 상단 meetup-190420-api 레파지토리를 클릭한 후 Clone or download 을 선택하고 Download Zip 버튼을 클릭해서 레파지토리 소스를 임의의 디렉토리에 다운로드 받고 압축을 해제합니다.
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4545 API Prototype Hands-on https://github.com/MangDan/meetup-190420-api http://oraclejet.org
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4646 API Prototype Hands-on https://github.com/MangDan/meetup-190420-api 오라클 JET (UI) 프로젝트안으로 이동, 소스내 URL을 API Gateway의 Endpoint로 변경 (이미 적용되어 있습니다.) • jet-movie-msa-ui/src/js/endpoints.json { "movies": "http://132.145.161.244:8011/api/search/v1/movies", "image": "https://image.tmdb.org/t/p/w185" } • JET UI를 시작하기 위해서 Oracle JET CLI를 설치 • npm install -g @oracle/ojet-cli
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4747 API Prototype Hands-on https://github.com/MangDan/meetup-190420-api • cd jet-movie-msa-ui • npm install @oracle/oraclejet-tooling --save • ojet serve http://localhost:8080
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4848 API First Design & Prototype
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4949 다음 시간에는…
Copyright © 2019, Oracle and/or its affiliates. All rights reserved. | 감사합니다. Confidential – Oracle Internal/Restricted/Highly Restricted 50

More Related Content

PPTX
Building microservice for api with helidon and cicd pipeline
DonghuKIM2
 
PDF
API Design Principles Essential 
Oracle Korea
 
PDF
JavaOne 2014 BOF4241 What's Next for JSF?
Edward Burns
 
PDF
DEVNET-2002 Coding 201: Coding Skills 201: Going Further with REST and Python...
Cisco DevNet
 
PDF
CON5898 What Servlet 4.0 Means To You
Edward Burns
 
PPTX
Servlet 4.0 at GeekOut 2015
Edward Burns
 
PDF
20191119 Cloud Native Java : GraalVM
Taewan Kim
 
PDF
Adopt-a-JSR for JSON Processing 1.1, JSR 374
Heather VanCura
 
Building microservice for api with helidon and cicd pipeline
DonghuKIM2
 
API Design Principles Essential 
Oracle Korea
 
JavaOne 2014 BOF4241 What's Next for JSF?
Edward Burns
 
DEVNET-2002 Coding 201: Coding Skills 201: Going Further with REST and Python...
Cisco DevNet
 
CON5898 What Servlet 4.0 Means To You
Edward Burns
 
Servlet 4.0 at GeekOut 2015
Edward Burns
 
20191119 Cloud Native Java : GraalVM
Taewan Kim
 
Adopt-a-JSR for JSON Processing 1.1, JSR 374
Heather VanCura
 

What's hot (20)

PDF
Spring boot microservice metrics monitoring
Oracle Korea
 
PPTX
Apic dc api deep dive
Cisco DevNet
 
PDF
MySQL InnoDB Cluster / ReplicaSet - Making Provisioning & Troubleshooting as ...
Miguel Araújo
 
PPTX
Jakarta EE: Today and Tomorrow
Dmitry Kornilov
 
PDF
Spring - CDI Interop
Ray Ploski
 
PPTX
HTTP/2 comes to Java. What Servlet 4.0 means to you. DevNexus 2015
Edward Burns
 
KEY
Apache, osgi and karaf par Guillaume Nodet
Normandy JUG
 
PPT
Reactive Java EE - Let Me Count the Ways!
Reza Rahman
 
PDF
Oracle APEX 기초 워크샵 - 실습 가이드 문서: Part 2 (2/2)
Taewan Kim
 
PDF
CamelOne 2013 Karaf A-MQ Camel CXF Security
Kenneth Peeples
 
PDF
Cloud Native Java GraalVM 이상과 현실
Taewan Kim
 
PDF
Web protocols for java developers
Pavel Bucek
 
PDF
MVC 1.0 / JSR 371
David Delabassee
 
PPT
GlassFish BOF
glassfish
 
PDF
EJB and CDI - Alignment and Strategy
David Delabassee
 
PPT
Down-to-Earth Microservices with Java EE
Reza Rahman
 
PDF
Modern web application development with java ee 7
Shekhar Gulati
 
PDF
WebSockets in Enterprise Applications
Pavel Bucek
 
PDF
WebSocket in Enterprise Applications 2015
Pavel Bucek
 
PDF
Puppet devops wdec
Wojciech Dec
 
Spring boot microservice metrics monitoring
Oracle Korea
 
Apic dc api deep dive
Cisco DevNet
 
MySQL InnoDB Cluster / ReplicaSet - Making Provisioning & Troubleshooting as ...
Miguel Araújo
 
Jakarta EE: Today and Tomorrow
Dmitry Kornilov
 
Spring - CDI Interop
Ray Ploski
 
HTTP/2 comes to Java. What Servlet 4.0 means to you. DevNexus 2015
Edward Burns
 
Apache, osgi and karaf par Guillaume Nodet
Normandy JUG
 
Reactive Java EE - Let Me Count the Ways!
Reza Rahman
 
Oracle APEX 기초 워크샵 - 실습 가이드 문서: Part 2 (2/2)
Taewan Kim
 
CamelOne 2013 Karaf A-MQ Camel CXF Security
Kenneth Peeples
 
Cloud Native Java GraalVM 이상과 현실
Taewan Kim
 
Web protocols for java developers
Pavel Bucek
 
MVC 1.0 / JSR 371
David Delabassee
 
GlassFish BOF
glassfish
 
EJB and CDI - Alignment and Strategy
David Delabassee
 
Down-to-Earth Microservices with Java EE
Reza Rahman
 
Modern web application development with java ee 7
Shekhar Gulati
 
WebSockets in Enterprise Applications
Pavel Bucek
 
WebSocket in Enterprise Applications 2015
Pavel Bucek
 
Puppet devops wdec
Wojciech Dec
 
Ad

Similar to Api design and prototype (20)

PDF
10thMeetup-20190420-REST API Design Principles 되새기기
DongHee Lee
 
PDF
Mobile Cloud Demo
Mee Nam Lee
 
PDF
Oracle Mobile Cloud / Bot
Mee Nam Lee
 
PDF
API 자동화 문서 도입기.pdf
ssuserc158fd
 
PDF
Oracle Mobile Solution Overview
Mee Nam Lee
 
PDF
Oracle cloud data interface
Oracle Korea
 
PPTX
RESTful API 제대로 만들기
Juwon Kim
 
PPTX
Java EE7
Jay Lee
 
PPTX
Before OTD EDU - Introduction
Beom Lee
 
PPTX
Jersey framework
knight1128
 
PPTX
Lw 4.1
준호 정
 
PPTX
Web application apis
재환 이
 
PDF
11회 Oracle Developer Meetup 발표 자료: Oracle NoSQL (2019.05.18) oracle-nosql pu...
Taewan Kim
 
PDF
Building multi tenancy enterprise applications
uEngine Solutions
 
PPTX
microservice architecture public education v2
uEngine Solutions
 
PDF
[Hello world 오픈세미나]공공정보와 네이버 오픈api
NAVER D2
 
PPTX
Oracle Cloud에서 애플리케이션을 개발하고 테스트하는 손쉬운 방법
Mee Nam Lee
 
PDF
Oracle Cloud World 2019 - Oracle Digital Assistant
Mee Nam Lee
 
PDF
Oracle Chatbot (챗봇) 솔루션
Mee Nam Lee
 
PDF
Oracle Blockchain Platform_Wonjo Yoo
Oracle Korea
 
10thMeetup-20190420-REST API Design Principles 되새기기
DongHee Lee
 
Mobile Cloud Demo
Mee Nam Lee
 
Oracle Mobile Cloud / Bot
Mee Nam Lee
 
API 자동화 문서 도입기.pdf
ssuserc158fd
 
Oracle Mobile Solution Overview
Mee Nam Lee
 
Oracle cloud data interface
Oracle Korea
 
RESTful API 제대로 만들기
Juwon Kim
 
Java EE7
Jay Lee
 
Before OTD EDU - Introduction
Beom Lee
 
Jersey framework
knight1128
 
Lw 4.1
준호 정
 
Web application apis
재환 이
 
11회 Oracle Developer Meetup 발표 자료: Oracle NoSQL (2019.05.18) oracle-nosql pu...
Taewan Kim
 
Building multi tenancy enterprise applications
uEngine Solutions
 
microservice architecture public education v2
uEngine Solutions
 
[Hello world 오픈세미나]공공정보와 네이버 오픈api
NAVER D2
 
Oracle Cloud에서 애플리케이션을 개발하고 테스트하는 손쉬운 방법
Mee Nam Lee
 
Oracle Cloud World 2019 - Oracle Digital Assistant
Mee Nam Lee
 
Oracle Chatbot (챗봇) 솔루션
Mee Nam Lee
 
Oracle Blockchain Platform_Wonjo Yoo
Oracle Korea
 
Ad

Recently uploaded (20)

PDF
Sensors and Actuators in IoT Systems using pdf
jeffinmathew654
 
PPTX
CroxyProxy Instagram Access id login.pptx
Orage technologies
 
PPTX
breach-and-attack-simulation-cybersecurity-india-chennai-defenderrabbit-2025....
defencerabbit Team
 
PDF
KodekX | Application Modernization Development
KodekX
 
PDF
HCSP-Presales-Campus Network Planning and Design V1.0 Training Material-Witho...
fahmeedakram1
 
PDF
CIFDAQ's Token Spotlight: SKY - A Forgotten Giant's Comeback?
CIFDAQ
 
PDF
AI And Its Effect On The Evolving IT Sector In Australia - Elevate
Elevate
 
PDF
Chapter 3 Spatial Domain Image Processing.pdf
Getnet Tigabie Askale -(GM)
 
PPTX
Detection-First SIEM: Rule Types, Dashboards, and Threat-Informed Strategy
ReZa AdineH
 
PDF
Enable Enterprise-Ready Security on IBM i Systems.pdf
Precisely
 
PDF
Peak of Data & AI Encore- AI for Metadata and Smarter Workflows
Safe Software
 
PDF
Cloud-Migration-Best-Practices-A-Practical-Guide-to-AWS-Azure-and-Google-Clou...
Artjoker Software Development Company
 
PPTX
Web Security: Login Bypass, SQLi, CSRF & XSS.pptx
SahilGupta752945
 
PPTX
How to Build Crypto Derivative Exchanges from Scratch.pptx
Tom Hardy S
 
PDF
CIFDAQ's Market Wrap: Ethereum Leads, Bitcoin Lags, Institutions Shift
CIFDAQ
 
PDF
How Onsite IT Support Drives Business Efficiency, Security, and Growth.pdf
Captain IT
 
PDF
Top Generative AI Tools for Patent Drafting in 2025.pdf
Content Swap
 
PDF
Event Presentation Google Cloud Next Extended 2025
minhtrietgect
 
PDF
Automating ArcGIS Content Discovery with FME: A Real World Use Case
Safe Software
 
PPTX
Belt and Road Supply Chain Finance Blockchain Solution
cyy111112
 
Sensors and Actuators in IoT Systems using pdf
jeffinmathew654
 
CroxyProxy Instagram Access id login.pptx
Orage technologies
 
breach-and-attack-simulation-cybersecurity-india-chennai-defenderrabbit-2025....
defencerabbit Team
 
KodekX | Application Modernization Development
KodekX
 
HCSP-Presales-Campus Network Planning and Design V1.0 Training Material-Witho...
fahmeedakram1
 
CIFDAQ's Token Spotlight: SKY - A Forgotten Giant's Comeback?
CIFDAQ
 
AI And Its Effect On The Evolving IT Sector In Australia - Elevate
Elevate
 
Chapter 3 Spatial Domain Image Processing.pdf
Getnet Tigabie Askale -(GM)
 
Detection-First SIEM: Rule Types, Dashboards, and Threat-Informed Strategy
ReZa AdineH
 
Enable Enterprise-Ready Security on IBM i Systems.pdf
Precisely
 
Peak of Data & AI Encore- AI for Metadata and Smarter Workflows
Safe Software
 
Cloud-Migration-Best-Practices-A-Practical-Guide-to-AWS-Azure-and-Google-Clou...
Artjoker Software Development Company
 
Web Security: Login Bypass, SQLi, CSRF & XSS.pptx
SahilGupta752945
 
How to Build Crypto Derivative Exchanges from Scratch.pptx
Tom Hardy S
 
CIFDAQ's Market Wrap: Ethereum Leads, Bitcoin Lags, Institutions Shift
CIFDAQ
 
How Onsite IT Support Drives Business Efficiency, Security, and Growth.pdf
Captain IT
 
Top Generative AI Tools for Patent Drafting in 2025.pdf
Content Swap
 
Event Presentation Google Cloud Next Extended 2025
minhtrietgect
 
Automating ArcGIS Content Discovery with FME: A Real World Use Case
Safe Software
 
Belt and Road Supply Chain Finance Blockchain Solution
cyy111112
 

Api design and prototype

  • 1. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1 th 김동후 (Oracle Korea) API Design and Prototype 2019.04.20 10 th Oracle Developer Meetup
  • 2. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 22 https://medium.com/better-practices/the-ultimate-api-publishers-guide-be74a2692326
  • 3. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | 3 How to Design a Good API and Why it Matters 조슈아 블로치 소프트웨어 아키텍처 Effective Java의 저자Public APIs, like diamonds, are forever. You have one chance to get it right so give it your best.
  • 4. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 44https://www.programmableweb.com/api-university/understanding-api-first-design
  • 5. 4-5배제품 출시 전 발생한 오류에 대한 해결 비용 100배제품 출시 후 유지보수 단계에서 확인된 오류에 대한 최대 해결 비용 5Copyright © 2018, Oracle and/or its affiliates. All rights reserved. API Design이 왜 중요한가? API-First design is a paradigm shift Relative Costs to Fix Software Defects (Source: IBM Systems Sciences Institute)
  • 6. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | API First Design & Prototype Process Confidential – Oracle Internal/Restricted/Highly Restricted 66
  • 7. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | API First Design Confidential – Oracle Internal/Restricted/Highly Restricted 77
  • 8. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 88
  • 9. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 99 https://smartbear.com/resources/ebooks/the-state-of-api-2019-report/ The State of API2019Report
  • 10. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Swagger, RAML, API Blueprint Confidential – Oracle Internal/Restricted/Highly Restricted 1010
  • 11. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | API Documentation Confidential – Oracle Internal/Restricted/Highly Restricted 1111
  • 12. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1212 API Blueprint 는 API Design First 접근을 위한 가장 적합한 방법
  • 13. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1313 https://apiblueprint.org/
  • 14. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1414 API Name and metadata
  • 15. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1515 Resource Groups
  • 16. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1616 Resource
  • 17. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1717 Actions Resource URI URI Template or Query Parameter {?param1, param2…} Path Parameter {param1}
  • 18. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1818 Request > Parameters + key : 샘플 값 (type, optional/required) - 설명
  • 19. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 1919 Request > Headers/Body Content-Type 지정 (보통 PUT/POST 에서 JSON 형식으로 넘길 경우 지정) Header 와 Header Key / Value 정의 PUT/POST 에서 JSON으로 데이터 전달할 때 JSON 형식의 샘플로 정의
  • 20. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2020 Response > Headers/Body Content-Type 지정 (JSON 형식으로 응답을 받는 경우) Header 와 Header Key / Value 정의 JSON 형식 응답을 받는 경우 JSON 형식의 샘플로 정의
  • 21. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2121 Response Without a Body
  • 22. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2222 Attributes (Markdown Syntax Objection Notation) 각 속성은 Parameters 지정과 동일 https://github.com/apiaryio/mson/blob/master/MSON%20Specification.md Included MoviePeopleMeta
  • 23. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2323 API Documentation Mock API Url
  • 24. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2424 API Blueprint Editors
  • 25. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2525 Apiary
  • 26. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2626 Vscode-apielements
  • 27. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2727 API Prototype
  • 28. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2828 API Prototype with API Gateway 프로토타입 UI • API Key, OAuth, Basic Auth • 트래픽 제어 • 단일 엔드 포인트 • 모니터링 • 로그 API Management & Gateway RESTful Service Resource RESTful Service Resource RESTful Service Resource RESTful Service Resource
  • 29. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 2929 API Prototype with API Gateway API 디자인 설계 프로토타입 UI API Mocking • API Key, OAuth, Basic Auth • 트래픽 제어 • 단일 엔드 포인트 • 모니터링 • 로그 API Management & Gateway
  • 30. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3030 API First Design & Prototype Hands-on 실습을 위한 준비 사항 • 깃헙 (https://github.com) 계정 – Apiary 계정을 만들기 위해서 필요 • Nodejs 설치 필요 • https://nodejs.org/ko/download/current/ • UI 프로토타입을 위해서 Oracle JET 설치를 위해 필요 (가급적 최신 버전) • https://github.com/MangDan/meetup-190420-api 다운로드해서 압축 해제
  • 31. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3131 API First Design Hands-on https://github.com/MangDan/meetup-190420-api
  • 32. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3232 API First Design Hands-on https://github.com/MangDan/meetup-190420-api
  • 33. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3333 API First Design Hands-on https://github.com/MangDan/meetup-190420-api 10 : ## 영화 정보 리소스 [/api/search/v1/movies] 12 : ### 영화 조회 [GET /api/search/v1/movies{?title}] 21 : + Parameters 22 : + title : 대부 (string, optional) – 제목 69 : ### 영화 상세 조회 [GET /api/search/v1/movies/{id}] tab
  • 34. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3434 API First Design Hands-on https://github.com/MangDan/meetup-190420-api 133 : # Data Structures 135 : ## MoviePeople (object) 136 : + Include MoviePeopleMeta 137 : + filmography : 쇼생크 탈출 (string, optional) - 필모그래피 139 : ## MoviePeopleMeta (object) 140 : + id : 10084614 (number, required) - 아이디 141 : + name : 프랭크 다라본트 (string, required) – 이름 142 : + role : 감독 (string, optional) - 역할 타이핑이 어려우신 분들은 1.3. API Blueprint 완성된 문서에서 복사해서 붙여넣기 하셔도 됩니다.
  • 35. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3535 API First Design Hands-on https://github.com/MangDan/meetup-190420-api 116 : + Attributes (array[MoviePeopleMeta]) 131 : + Attributes (MoviePeople) tab tab 여기까지 못 따라 오신 분들은 1.3. API Blueprint 완성된 문서 내용을 붙여넣기 하셔도 됩니다.
  • 36. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3636 API First Design Hands-on https://github.com/MangDan/meetup-190420-api
  • 37. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3737 API First Design Hands-on https://github.com/MangDan/meetup-190420-api
  • 38. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3838 API First Design Hands-on https://github.com/MangDan/meetup-190420-api
  • 39. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 3939 API First Design Hands-on https://github.com/MangDan/meetup-190420-api
  • 40. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4040 API First Design Hands-on https://github.com/MangDan/meetup-190420-api UI Prototype을 위해서 Mock 서버의 호스트 정보를 확인합니다. e.g.) http://private-df8a0-api722.apiary-mock.com
  • 41. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4141 API Prototype Hands-on https://github.com/MangDan/meetup-190420-api API 디자인 설계 • CORS • api_key API Management & Gateway API Mocking 두개의 보안 정책 적용
  • 42. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4242 API Prototype Hands-on https://github.com/MangDan/meetup-190420-api API 게이트웨이 배포 http://132.145.161.244:8011/api/search/v1
  • 43. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4343 API Prototype Hands-on https://github.com/MangDan/meetup-190420-api API 디자인 설계 API Mocking • CORS • api_key API Management & Gateway http://132.145.161.244:8011/api/search/v1 endpoint
  • 44. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4444 API Prototype Hands-on https://github.com/MangDan/meetup-190420-api 상단 meetup-190420-api 레파지토리를 클릭한 후 Clone or download 을 선택하고 Download Zip 버튼을 클릭해서 레파지토리 소스를 임의의 디렉토리에 다운로드 받고 압축을 해제합니다.
  • 45. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4545 API Prototype Hands-on https://github.com/MangDan/meetup-190420-api http://oraclejet.org
  • 46. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4646 API Prototype Hands-on https://github.com/MangDan/meetup-190420-api 오라클 JET (UI) 프로젝트안으로 이동, 소스내 URL을 API Gateway의 Endpoint로 변경 (이미 적용되어 있습니다.) • jet-movie-msa-ui/src/js/endpoints.json { "movies": "http://132.145.161.244:8011/api/search/v1/movies", "image": "https://image.tmdb.org/t/p/w185" } • JET UI를 시작하기 위해서 Oracle JET CLI를 설치 • npm install -g @oracle/ojet-cli
  • 47. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4747 API Prototype Hands-on https://github.com/MangDan/meetup-190420-api • cd jet-movie-msa-ui • npm install @oracle/oraclejet-tooling --save • ojet serve http://localhost:8080
  • 48. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4848 API First Design & Prototype
  • 49. Copyright © 2017, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 4949 다음 시간에는…
  • 50. Copyright © 2019, Oracle and/or its affiliates. All rights reserved. | 감사합니다. Confidential – Oracle Internal/Restricted/Highly Restricted 50

Editor's Notes

  • #3: Log in to Media Manager (https://omm.us.oracle.com) using your SSO and select the ASSETS tab from the main top navigation bar. From there you can use the faceted navigation provided under the filter to go to: Look & Feels > Branded Systems > Groundbreakers > Taglines Or copy the URL below and paste into a browser that functions properly with Media Manager: Oracle Developer Tagline https://omm.us.oracle.com:11443/otmm/ux-html/?p=collection%2Furl_selection%2F30810053
  • #5: Slate : Markdown and Ruby
  • #7: https://hub.packtpub.com/implementing-an-api-design-first-approach-for-building-apis/
  • #8: https://hub.packtpub.com/implementing-an-api-design-first-approach-for-building-apis/
  • #9: Log in to Media Manager (https://omm.us.oracle.com) using your SSO and select the ASSETS tab from the main top navigation bar. From there you can use the faceted navigation provided under the filter to go to: Look & Feels > Branded Systems > Groundbreakers > Taglines Or copy the URL below and paste into a browser that functions properly with Media Manager: Oracle Developer Tagline https://omm.us.oracle.com:11443/otmm/ux-html/?p=collection%2Furl_selection%2F30810053
  • #10: Log in to Media Manager (https://omm.us.oracle.com) using your SSO and select the ASSETS tab from the main top navigation bar. From there you can use the faceted navigation provided under the filter to go to: Look & Feels > Branded Systems > Groundbreakers > Taglines Or copy the URL below and paste into a browser that functions properly with Media Manager: Oracle Developer Tagline https://omm.us.oracle.com:11443/otmm/ux-html/?p=collection%2Furl_selection%2F30810053
  • #11: Slate : Markdown and Ruby
  • #13: Log in to Media Manager (https://omm.us.oracle.com) using your SSO and select the ASSETS tab from the main top navigation bar. From there you can use the faceted navigation provided under the filter to go to: Look & Feels > Branded Systems > Groundbreakers > Taglines Or copy the URL below and paste into a browser that functions properly with Media Manager: Oracle Developer Tagline https://omm.us.oracle.com:11443/otmm/ux-html/?p=collection%2Furl_selection%2F30810053
  • #14: Log in to Media Manager (https://omm.us.oracle.com) using your SSO and select the ASSETS tab from the main top navigation bar. From there you can use the faceted navigation provided under the filter to go to: Look & Feels > Branded Systems > Groundbreakers > Taglines Or copy the URL below and paste into a browser that functions properly with Media Manager: Oracle Developer Tagline https://omm.us.oracle.com:11443/otmm/ux-html/?p=collection%2Furl_selection%2F30810053
  • #15: The blueprint starts with a metadata section. In this case we have specified that FORMAT has the value of 1A. The format keyword denotes the version of the API Blueprint. The first heading in the blueprint serves as the name of your API, which in this case is "Polls". Headings start with one or more # symbols followed by a title. The API Name here uses one hash to distinguish it as the first level. The number of # you use will determine the level of the heading. Following the heading is a description of the API. You may use further headings to break up the description section.
  • #16: The blueprint starts with a metadata section. In this case we have specified that FORMAT has the value of 1A. The format keyword denotes the version of the API Blueprint. The first heading in the blueprint serves as the name of your API, which in this case is "Polls". Headings start with one or more # symbols followed by a title. The API Name here uses one hash to distinguish it as the first level. The number of # you use will determine the level of the heading. Following the heading is a description of the API. You may use further headings to break up the description section.
  • #17: The blueprint starts with a metadata section. In this case we have specified that FORMAT has the value of 1A. The format keyword denotes the version of the API Blueprint. The first heading in the blueprint serves as the name of your API, which in this case is "Polls". Headings start with one or more # symbols followed by a title. The API Name here uses one hash to distinguish it as the first level. The number of # you use will determine the level of the heading. Following the heading is a description of the API. You may use further headings to break up the description section.
  • #18: The blueprint starts with a metadata section. In this case we have specified that FORMAT has the value of 1A. The format keyword denotes the version of the API Blueprint. The first heading in the blueprint serves as the name of your API, which in this case is "Polls". Headings start with one or more # symbols followed by a title. The API Name here uses one hash to distinguish it as the first level. The number of # you use will determine the level of the heading. Following the heading is a description of the API. You may use further headings to break up the description section.
  • #19: The blueprint starts with a metadata section. In this case we have specified that FORMAT has the value of 1A. The format keyword denotes the version of the API Blueprint. The first heading in the blueprint serves as the name of your API, which in this case is "Polls". Headings start with one or more # symbols followed by a title. The API Name here uses one hash to distinguish it as the first level. The number of # you use will determine the level of the heading. Following the heading is a description of the API. You may use further headings to break up the description section.
  • #20: The blueprint starts with a metadata section. In this case we have specified that FORMAT has the value of 1A. The format keyword denotes the version of the API Blueprint. The first heading in the blueprint serves as the name of your API, which in this case is "Polls". Headings start with one or more # symbols followed by a title. The API Name here uses one hash to distinguish it as the first level. The number of # you use will determine the level of the heading. Following the heading is a description of the API. You may use further headings to break up the description section.
  • #21: The blueprint starts with a metadata section. In this case we have specified that FORMAT has the value of 1A. The format keyword denotes the version of the API Blueprint. The first heading in the blueprint serves as the name of your API, which in this case is "Polls". Headings start with one or more # symbols followed by a title. The API Name here uses one hash to distinguish it as the first level. The number of # you use will determine the level of the heading. Following the heading is a description of the API. You may use further headings to break up the description section.
  • #51: This is a Section Header without Picture, and can also be used as a Q and A slide.