Skip to Content

Changes for page HTTP Resources

Last modified by Erik Bakker on 2024/08/23 10:51
From version 22.1
edited by Danniar Firdausy
on 2024/08/21 10:25
Change comment: There is no comment for this version
To version 20.1
edited by Danniar Firdausy
on 2024/08/21 10:24
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -10,7 +10,7 @@
10 10  == 2. Key concepts ==
11 11  
12 12  This microlearning centers around HTTP Resource (Paths) in conjunction with the API Gateway solution of eMagiz.
13 -With HTTP Resource Paths we mean: Identify the resource (e.g., Client, Order, Employee) and define the descriptive path (i.e., {{code language=text}}/v1/order{{/code}}, {{code language=text}}/v1/order/{uuid}{{/code}}) an external party can call to execute the operation.
13 +With HTTP Resource Paths we mean: Identify the resource (e.g., Client, Order, Employee) and define the descriptive path (i.e., {{code language=text}}/v1/order{{/code}}, {{code}}/v1/order/{uuid}{{/code}}) an external party can call to execute the operation.
14 14  With API Gateway we mean: A collection of RESTful API operations that can be published to the outside world to give them access to applications that are linked to your business process.
15 15  
16 16  When determining the correct resource path to expose to the outside world start at what you want to make publicly available.
... ... @@ -23,7 +23,8 @@
23 23  * /order-management/orders
24 24  * /order-management/trips
25 25  
26 -To determine the correct notation also take into account how the backend system that you want to expose via the API Gateway has determined their HTTP Resource (Paths). If this adheres to the best practice simply use that. More on that specific relation in later microlearnings.
26 +To determine the correct notation also take into account how the backend system that you want to expose via the API Gateway has determined their HTTP Resource (Paths).
27 +If this adheres to the best practice simply use that. More on that specific relation in later microlearnings.
27 27  
28 28  A list of best practices can be found here:
29 29  [[REST API naming concepts>>https://restfulapi.net/resource-naming/||target="blank"]]