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 26.1
edited by Erik Bakker
on 2024/08/23 10:50
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.dfirdausy
1 +XWiki.ebakker
Content
... ... @@ -10,24 +10,11 @@
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.
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 -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:
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.
18 18  
19 -* /orders
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.
20 20  
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). If this adheres to the best practice simply use that. More on that specific relation in later microlearnings.
27 -
28 -A list of best practices can be found here:
29 -[[REST API naming concepts>>https://restfulapi.net/resource-naming/||target="blank"]]
30 -
31 31  == 3. HTTP Resource (Paths) ==
32 32  
33 33  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.
... ... @@ -35,12 +35,12 @@
35 35  When determining the correct resource path to expose to the outside world, start at what you want to make publicly available.
36 36  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:
37 37  
38 -* /orders
25 +* {{code language=text}}/orders{{/code}}
39 39  
40 40  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:
41 41  
42 -* /order-management/orders
43 -* /order-management/trips
29 +* {{code language=text}}/order-management/orders{{/code}}
30 +* {{code language=text}}/order-management/trips{{/code}}
44 44  
45 45  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).
46 46  If this adheres to the best practice simply use that. More on that specific relation in later microlearnings.
... ... @@ -61,10 +61,10 @@
61 61  
62 62  If you are interested in this topic and want more information on it please read the help text provided by eMagiz and read the following links:
63 63  
64 -* [[REST API naming concepts (External)>>https://restfulapi.net/resource-naming/||target="blank"]]
65 65  * [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
66 66  ** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]]
67 67  *** [[Swagger UI (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-swagger-ui||target="blank"]]
68 68  *** [[HTTP Operations (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-http-operations||target="blank"]]
55 +* [[REST API naming concepts (External)>>https://restfulapi.net/resource-naming/||target="blank"]]
69 69  * [[HTTP Resources (Search Results)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&l_space_facet=10&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22HTTP+Resources%22||target="blank"]]
70 70  )))((({{toc/}}))){{/container}}{{/container}}