SlideShare a Scribd company logo

REST-API overview / concepts

•
•
Patrick Savalle
Patrick Savalle

The article 'Design Patterns for REST-APIs, plus a quick primer on what they are' is here: https://hersengarage.nl/rest-api-design-as-a-craft-not-an-art-a3fd97ed3ef4

Related slideshows

REST API
REST APIREST API
REST API
 
REST API Design & Development
REST API Design & DevelopmentREST API Design & Development
REST API Design & Development
 
RESTful API - Best Practices
RESTful API - Best PracticesRESTful API - Best Practices
RESTful API - Best Practices
 
1 of 1
Download to read offline
Object model Function model Code DELETE /V1/<ENTITY> headers body SERVER IMPLEMENTATION QUALITY Documentation Developer dashboard Language stubs Homepage / product page Business model OpenAPI definition ARTIFACTS Computer program Enterprise Mechatronical Biological Technological Minimal Complete Cohesive Encapsulating Self-explaining Consistent Documented GET /V1/<ENTITY> headers body POST /V1/<ENTITY> headers body PUT /V1/<ENTITY> headers body PATCH /V1/<ENTITY> headers body DELETE /V1/<ENTITY> headers body REST-API Server REST-model Domain model Interaction model REST-API CONCEPTS REST-API DEFINITION  THE SET OF VALID HTTP-REQUESTS TO A SERVER  PLUS THE CORRESPONDING RESPONSES  PLUS THE PRE-CONDITIONS, INVARIANTS AND POST- CONDITIONS  OFTEN DEFINED IN A SWAGGER / OPENAPI YAML FILE REST-API PARADIGM  MAPS INDIVIDUAL LOGICAL AND PHYSICAL SERVER RESOURCES ON URLS  ALLOWS ‘CRUD’ OPERATIONS ON THOSE RESOURCES  STATELESS, THE SERVER STORES NO CLIENT STATE OR SESSION A REST-API IS A PROJECTION OF SERVER RESOURCES ONTO URL’S Created by: patrick@patricksavalle.com <VERB> <URL> <headers> <body> <RESPONSE CODE> <headers> <body> HTTP request HTTP response Scenario’s and use-cases Domain model Internal Data model and structures API DESIGN DYNAMICS DIFFERENT MODELS OF SAME SERVER. The API cheat sheet: https://github.com/patricksavalle/rest-api-cheatsheet

More Related Content

REST-API overview / concepts

  • 1. Object model Function model Code DELETE /V1/<ENTITY> headers body SERVER IMPLEMENTATION QUALITY Documentation Developer dashboard Language stubs Homepage / product page Business model OpenAPI definition ARTIFACTS Computer program Enterprise Mechatronical Biological Technological Minimal Complete Cohesive Encapsulating Self-explaining Consistent Documented GET /V1/<ENTITY> headers body POST /V1/<ENTITY> headers body PUT /V1/<ENTITY> headers body PATCH /V1/<ENTITY> headers body DELETE /V1/<ENTITY> headers body REST-API Server REST-model Domain model Interaction model REST-API CONCEPTS REST-API DEFINITION  THE SET OF VALID HTTP-REQUESTS TO A SERVER  PLUS THE CORRESPONDING RESPONSES  PLUS THE PRE-CONDITIONS, INVARIANTS AND POST- CONDITIONS  OFTEN DEFINED IN A SWAGGER / OPENAPI YAML FILE REST-API PARADIGM  MAPS INDIVIDUAL LOGICAL AND PHYSICAL SERVER RESOURCES ON URLS  ALLOWS ‘CRUD’ OPERATIONS ON THOSE RESOURCES  STATELESS, THE SERVER STORES NO CLIENT STATE OR SESSION A REST-API IS A PROJECTION OF SERVER RESOURCES ONTO URL’S Created by: patrick@patricksavalle.com <VERB> <URL> <headers> <body> <RESPONSE CODE> <headers> <body> HTTP request HTTP response Scenario’s and use-cases Domain model Internal Data model and structures API DESIGN DYNAMICS DIFFERENT MODELS OF SAME SERVER. The API cheat sheet: https://github.com/patricksavalle/rest-api-cheatsheet