Add documentation

package.json

@@ -3,13 +3,12 @@
 	"version": "1.0.50",
 	"scripts": {
 		"dev": "bun run --watch src/index.ts",
-
 		"check": "biome check .",
 		"check:apply": "biome check --apply .",
-
 		"edgedb": "bunx @edgedb/generate edgeql-js"
 	},
 	"dependencies": {
+		"@elysiajs/swagger": "^1.0.3",
 		"edgedb": "^1.4.1",
 		"elysia": "latest",
 		"elysia-http-status-code": "^1.0.9",

src/constants/general.ts

@@ -0,0 +1 @@
+export const VERSION = "a2.0.0";

src/index.ts

@@ -1,3 +1,5 @@
+import { swagger } from "@elysiajs/swagger";
+import { VERSION } from "constants/general";
 import { Elysia } from "elysia";
 import { accessTokenRouter } from "routes/auth/accessToken";
 import { refreshTokenRouter } from "routes/auth/refreshToken";
@@ -7,11 +9,42 @@ import { edgedb } from "../dbschema/edgeql-js/imports";
 export const client = edgedb.createClient();
 
 const app = new Elysia()
-	.get("/", () => ({
-		name: "Dlool",
-		isDlool: true,
-		version: "a2.0.0",
-	}))
+	.use(
+		swagger({
+			documentation: {
+				info: {
+					title: "Dlool API",
+					license: {
+						name: "GPL-3.0",
+						url: "https://www.gnu.org/licenses/gpl-3.0.html",
+					},
+					version: VERSION,
+				},
+				externalDocs: {
+					description:
+						"The Dlool documentation for general information and usage of the frontend.",
+					url: "https://dlool.me/documentation",
+				},
+				tags: [
+					{ name: "App", description: "General app information" },
+					{ name: "Auth", description: "Authentication endpoints" },
+				],
+			},
+		}),
+	)
+	.get(
+		"/",
+		() => ({
+			name: "Dlool",
+			isDlool: true,
+			version: VERSION,
+		}),
+		{
+			detail: {
+				tags: ["App"],
+			},
+		},
+	)
 	.group("/auth", (app) =>
 		app.use(registerRouter).use(refreshTokenRouter).use(accessTokenRouter),
 	)

src/routes/auth/accessToken.ts

@@ -43,5 +43,6 @@ export const accessTokenRouter = new Elysia({ prefix: "/access-token" })
 			body: t.Object({
 				refreshToken: t.String({ minLength: 1 }),
 			}),
+			detail: { tags: ["Auth"] },
 		},
 	);

src/routes/auth/refreshToken.ts

@@ -96,5 +96,6 @@ export const refreshTokenRouter = new Elysia({ prefix: "/refresh-token" })
 				username: t.String({ minLength: 1 }),
 				password: t.String({ minLength: 1 }),
 			}),
+			detail: { tags: ["Auth"] },
 		},
 	);

src/routes/auth/register.ts

@@ -47,13 +47,22 @@ export const registerRouter = new Elysia({ prefix: "/register" })
 			body: t.Object({
 				username: t.String({
 					minLength: 1,
+					description: "The username must be unique and will be used to login",
 				}),
 				displayname: t.String({
 					minLength: 1,
+					description:
+						"The display name will be shown to other users and does not need to be unique",
 				}),
-				password: t.RegExp(
-					/^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[#?!@$ %^&*-]).{8,}$/,
-				),
+				password: t.String({
+					minLength: 8,
+					description:
+						"Password must contain at least 8 characters, one uppercase letter, one lowercase letter, one number, and one special character",
+					pattern:
+						"^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[#?!@$ %^&*-]).{8,}$",
+				}),
+				// t.RegExp(),
 			}),
+			detail: { tags: ["Auth"] },
 		},
 	);