API docs

2024-12-29 23:29:33 -05:00
parent c2df6028b3
commit cad40565b0
11 changed files with 689 additions and 0 deletions
--- a/docs/routes.md
+++ b/docs/routes.md
@@ -0,0 +1,73 @@
+## Routes
+
+<details>
+<summary>`/`</summary>
+
+- [RequestID]()
+- [Logger]()
+- [Recoverer]()
+- [URLFormat]()
+- [git.dubyatp.xyz/chat-api-server/api.Start.SetContentType.func5]()
+- **/**
+        - _GET_
+                - [Start.func1]()
+
+</details>
+<details>
+<summary>`/messages`</summary>
+
+- [RequestID]()
+- [Logger]()
+- [Recoverer]()
+- [URLFormat]()
+- [git.dubyatp.xyz/chat-api-server/api.Start.SetContentType.func5]()
+- **/messages**
+        - **/**
+                - _GET_
+                        - [ListMessages]()
+
+</details>
+<details>
+<summary>`/messages/{messageID}`</summary>
+
+- [RequestID]()
+- [Logger]()
+- [Recoverer]()
+- [URLFormat]()
+- [git.dubyatp.xyz/chat-api-server/api.Start.SetContentType.func5]()
+- **/messages**
+        - **/{messageID}**
+                - [MessageCtx]()
+                - **/**
+                        - _GET_
+                                - [GetMessage]()
+
+</details>
+<details>
+<summary>`/panic`</summary>
+
+- [RequestID]()
+- [Logger]()
+- [Recoverer]()
+- [URLFormat]()
+- [git.dubyatp.xyz/chat-api-server/api.Start.SetContentType.func5]()
+- **/panic**
+        - _GET_
+                - [Start.func3]()
+
+</details>
+<details>
+<summary>`/ping`</summary>
+
+- [RequestID]()
+- [Logger]()
+- [Recoverer]()
+- [URLFormat]()
+- [git.dubyatp.xyz/chat-api-server/api.Start.SetContentType.func5]()
+- **/ping**
+        - _GET_
+                - [Start.func2]()
+
+</details>
+
+Total # of routes: 5