Skip to Content

Changes for page HTTP Resources

Last modified by Erik Bakker on 2024/08/23 10:51
From version 23.1
edited by Danniar Firdausy
on 2024/08/21 10:31
Change comment: There is no comment for this version
To version 18.1
edited by Danniar Firdausy
on 2024/08/21 10:22
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -10,11 +10,25 @@
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}}/v1/order{{/code}}, /v1/order/{uuid}) an external party can call to execute the operation.
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.
13 13  
14 -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.
16 +When determining the correct resource path to expose to the outside world start at what you want to make publicly available.
17 +For example, when you want to make it possible for external parties to retrieve a collection of orders without any filter a valid resource path can be:
15 15  
16 -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.
19 +* /orders
17 17  
21 +If you have multiple resources that you want to make available that all have something to do with the order process you could add each of them to a 'group' to add an extra layer of information:
22 +
23 +* /order-management/orders
24 +* /order-management/trips
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).
27 +If this adheres to the best practice simply use that. More on that specific relation in later microlearnings.
28 +
29 +A list of best practices can be found here:
30 +[[REST API naming concepts>>https://restfulapi.net/resource-naming/||target="blank"]]
31 +
18 18  == 3. HTTP Resource (Paths) ==
19 19  
20 20  This microlearning focuses on the theoretical part of HTTP Resources regardless of a specific implementation in eMagiz. In the microlearnings that will come, we will use this theoretical knowledge when we configure our API Gateway further.