Skip to Content

Changes for page HTTP Resources

Last modified by Erik Bakker on 2024/08/23 10:51
From version 2.1
edited by Erik Bakker
on 2022/06/10 08:37
Change comment: Imported from XAR
To version 7.1
edited by Eva Torken
on 2023/04/20 11:33
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +HTTP Resources
Parent
... ... @@ -1,0 +1,1 @@
1 +WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.etorken
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,14 +1,9 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -= HTTP Resource (Paths) =
3 -
4 4  In this microlearning, we will focus on learning about HTTP Resource (Paths).
5 5  A crucial part of setting up your (API) Gateway with the help of RESTful services is knowing to which resources (i.e. Order, Client, Employee) you want to give external parties access via your (API) Gateway.
6 6  
7 7  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
8 8  
9 -* Last update: April 14th, 2021
10 -* Required reading time: 4 minutes
11 -
12 12  == 1. Prerequisites ==
13 13  
14 14  * Basic knowledge of the eMagiz platform
... ... @@ -16,8 +16,8 @@
16 16  == 2. Key concepts ==
17 17  
18 18  This microlearning centers around HTTP Resource (Paths) in conjunction with the API Gateway solution of eMagiz.
19 -With HTTP Resource Paths we mean: Identify the resource (i.e. Client, Order, Employee) and define the descriptive path (i.e. /v1/order, /v1/order/{uuid}) an external party can call to execute the operation
20 -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
14 +With HTTP Resource Paths we mean: Identify the resource (i.e. Client, Order, Employee) and define the descriptive path (i.e. /v1/order, /v1/order/{uuid}) an external party can call to execute the operation.
15 +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.
21 21  
22 22  When determining the correct resource path to expose to the outside world start at what you want to make publicly available.
23 23  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:
... ... @@ -33,15 +33,13 @@
33 33  If this adheres to the best practice simply use that. More on that specific relation in later microlearnings.
34 34  
35 35  A list of best practices can be found here:
36 -https://restfulapi.net/resource-naming/
31 +[[REST API naming concepts>>https://restfulapi.net/resource-naming/||target="blank"]]
37 37  
38 -
39 -
40 40  == 3. HTTP Resource (Paths) ==
41 41  
42 42  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.
43 43  
44 -When determining the correct resource path to expose to the outside world start at what you want to make publicly available.
37 +When determining the correct resource path to expose to the outside world, start at what you want to make publicly available.
45 45  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:
46 46  
47 47  * /orders
... ... @@ -55,13 +55,11 @@
55 55  If this adheres to the best practice simply use that. More on that specific relation in later microlearnings.
56 56  
57 57  A list of best practices can be found here:
58 -https://restfulapi.net/resource-naming/
51 +[[REST API naming concepts>>https://restfulapi.net/resource-naming/||target="blank"]]
59 59  
60 60  In the following microlearning on HTTP Operations, we will bring the HTTP Resource (Paths) together with the HTTP Operations.
61 61  That combination is the basis for any integration that runs via the API Gateway.
62 62  
63 -
64 -
65 65  == 4. Assignment ==
66 66  
67 67  Read up on the best practices when it comes to the naming of HTTP Resource Paths and see if you can relate this to the eMagiz implementation.
... ... @@ -73,13 +73,11 @@
73 73  * Determine usability of what is provided to you
74 74  * Take action based on that analysis
75 75  
76 -
77 -
78 78  == 6. Suggested Additional Readings ==
79 79  
80 80  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:
81 81  
82 -* https://restfulapi.net/resource-naming/
71 +* [[REST API naming concepts>>https://restfulapi.net/resource-naming/||target="blank"]]
83 83  
84 84  == 7. Silent demonstration video ==
85 85