docs: add API route standard

Dwigoric · Nov 29, 2023 · bc96142 · bc96142
1 parent c30ad38
commit bc96142
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 6 deletions.
diff --git a/docs/topics/Express-Routes.md b/docs/topics/Express-Routes.md
@@ -0,0 +1,44 @@
+# Express Routes
+
+The route paths define the endpoints at which requests can be made.
+
+Depending on the HTTP method used, the Express router will call the corresponding method handler function.
+
+## CRUD Operations
+
+The following table shows the HTTP methods and their corresponding Express router methods:
+
+| HTTP Method | Express Router Method | CRUD Operation | Description                    |
+| ----------- | --------------------- |----------------|--------------------------------|
+| GET         | `router.get()`        | Read           | Retrieve information           |
+| POST        | `router.post()`       | Create         | Send information to the server | 
+| PUT         | `router.put()`        | Create         | Create a new resource          |
+| PATCH       | `router.patch()`      | Update         | Update an existing resource    |
+| DELETE      | `router.delete()`     | Delete         | Delete an existing resource    |
+
+## Route Paths
+
+The route paths define the endpoints at which requests can be made.
+
+Route paths can be strings, string patterns, or regular expressions.
+
+### Resource Naming
+
+For this project, we follow the industry standard of naming conventions,
+which you may find [here](https://restfulapi.net/resource-naming/).
+
+<seealso>
+    <category ref="uh">
+        <a href="Admin.md" />
+        <a href="Authenticating-Logging-In.md" />
+        <a href="Loans.md" />
+        <a href="Deposits.md" />
+        <a href="Profiles.md" />
+    </category>
+    <category ref="ds">
+        <a href="Naming.md" />
+        <a href="Comments.md" />
+        <a href="Code-Style.md" />
+        <a href="Git-Commit-Messages.md" />
+    </category>
+</seealso>
diff --git a/docs/ucwa.tree b/docs/ucwa.tree
@@ -7,12 +7,6 @@
                  start-page="Introduction.md">
 
     <toc-element topic="Introduction.md"/>
-    <toc-element topic="Coding-Standards.md">
-        <toc-element topic="Naming.md"/>
-        <toc-element topic="Comments.md"/>
-        <toc-element topic="Code-Style.md"/>
-    </toc-element>
-    <toc-element topic="Git-Commit-Messages.md"/>
     <toc-element topic="User-Handbook.md">
         <toc-element topic="Authenticating-Logging-In.md"/>
         <toc-element topic="Loans.md">
@@ -34,4 +28,11 @@
             <toc-element topic="Notification-Settings.md"/>
         </toc-element>
     </toc-element>
+    <toc-element topic="Coding-Standards.md">
+        <toc-element topic="Naming.md"/>
+        <toc-element topic="Comments.md"/>
+        <toc-element topic="Code-Style.md"/>
+    </toc-element>
+    <toc-element topic="Git-Commit-Messages.md"/>
+    <toc-element topic="Express-Routes.md"/>
 </instance-profile>