REST-API overview / concepts
0 likes836 views
The document provides an overview of REST API concepts, including the structure of HTTP requests and responses, as well as server interactions. It highlights the stateless nature of REST APIs and their alignment with CRUD operations for managing resources via URLs. Additionally, it references an API cheat sheet for further guidance on implementation.
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