Embed Size (px)
Citation preview
Object model
Function model
Technical
datamodel
DELETE /V1/<ENTITY>
headers
body
DELETE /V1/<ENTITY>
headers
body
DELETE /V1/<ENTITY>
headers
body
IMPLEMENTATION
QUALITY
Endpoint documentation
Developer dashboard
Language stubs
Homepage / productpage
Revenue model
Launch party
Hackathons
Endpoint documentation
Developer dashboard
Language stubs
Homepage / productpage
Revenue model
Launch party
Hackathons
DELIVERABLES
Computer program
Artificial intelligence
Mechatronical
Human, biological
Entire company
Computer program
Artificial intelligence
Mechatronical
Human, biological
Entire company
Minimal
Complete
Cohesive
Encapsulating
Self-explaining
Consistent
Documented
Minimal
Complete
Cohesive
Encapsulating
Self-explaining
Consistent
Documented
GET /V1/<ENTITY>
headers
body
GET /V1/<ENTITY>
headers
body
GET /V1/<ENTITY>
headers
body
POST /V1/<ENTITY>
headers
body
POST /V1/<ENTITY>
headers
body
POST /V1/<ENTITY>
headers
body
PUT /V1/<ENTITY>
headers
body
PUT /V1/<ENTITY>
headers
body
PUT /V1/<ENTITY>
headers
body
PATCH /V1/<ENTITY>
headers
body
PATCH /V1/<ENTITY>
headers
body
PATCH /V1/<ENTITY>
headers
body
DELETE /V1/<ENTITY>
headers
body
DELETE /V1/<ENTITY>
headers
body
DELETE /V1/<ENTITY>
headers
body
REST-API
Enterprise
resources
REST-model
Logical datamodel
Interaction model
REST-API REFERENCE REST-API DEFINITION
• THE SET OF VALID HTTP-REQUESTS TO A COMPONENT
• PLUS THE CORRESPONDING RESPONSES
• PLUS THE PRE-CONDITIONS, INVARIANTS AND POST-
CONDITIONS
• OFTEN SUMMARIZED AS A LIST OF ENDPOINTS (FIRST LINE OF
HTTP-REQUEST)
• FORMALLY DEFINED IN AN OPEN-API (YAML) SPECIFICATION
REST-API PARADIGM
• MAPS INDIVIDUAL LOGICAL AND / OR PHYSICAL ENTERPRISE
RESOURCES ON URL S
• ALLOWS CRUD OPERATIONS ON THOSE RESOURCES
A REST-API IS A PROJECTION
OF ENTERPRISE RESOURCES
ONTO URL S
Created by: [email protected]
<VERB> <URL>
<header>
<body>
<VERB> <URL>
<header>
<body>
<VERB> <URL>
<header>
<body>
<RESPONSE CODE>
<header>
<body>
<RESPONSE CODE>
<header>
<body>
<RESPONSE CODE>
<header>
<body>
HTTP request
HTTP response
Outward facing
Interaction model
Outward facing
logical datamodel
Internal
datamodel
and structures
API
DESIGN FORCES
COMPATIBLE PROJECTIONS OF
SAME UNDERLYING STRUCTURE
Security https://www.owasp.org/index.php/REST_Security_Cheat_Sheet
HTTP-VERBS
POST – CREATE NEW RESOURCE
PUT – REPLACE RESOURCE
PATCH – (PARTIALLY) UPDATE RESOURCE
GET – LIST OR GET RESOURCE
DELETE – DELETE RESOURCE
![[MS-CPREST]: Control Plane REST API... · 2020-03-05 · Control Plane REST API . . . ,](https://img.pdfslide.net/doc/110x75/5f708c35fb16f51a332373f6/ms-cprest-control-plane-rest-api-2020-03-05-control-plane-rest-api-.jpg)
