chore: Define hoarder's rest API in zod format

1 files changed, 46 insertions, 0 deletions

diff --git a/packages/open-api/index.ts b/packages/open-api/index.ts
new file mode 100644
index 00000000..da5b3729
--- /dev/null
+++ b/packages/open-api/index.ts
@@ -0,0 +1,46 @@
+import * as fs from "fs";
+import {
+  OpenApiGeneratorV3,
+  OpenAPIRegistry,
+} from "@asteasolutions/zod-to-openapi";
+import * as yaml from "yaml";
+
+import { registry as bookmarksRegistry } from "./lib/bookmarks";
+import { registry as commonRegistry } from "./lib/common";
+import { registry as listsRegistry } from "./lib/lists";
+import { registry as tagsRegistry } from "./lib/tags";
+
+function getOpenApiDocumentation() {
+  const registry = new OpenAPIRegistry([
+    commonRegistry,
+    bookmarksRegistry,
+    listsRegistry,
+    tagsRegistry,
+  ]);
+
+  const generator = new OpenApiGeneratorV3(registry.definitions);
+
+  return generator.generateDocument({
+    openapi: "3.0.0",
+    info: {
+      version: "1.0.0",
+      title: "Hoarder API",
+      description: "The API for the Hoarder app",
+    },
+    servers: [{ url: "v1" }],
+  });
+}
+
+function writeDocumentation() {
+  // OpenAPI JSON
+  const docs = getOpenApiDocumentation();
+
+  // YAML equivalent
+  const fileContent = yaml.stringify(docs);
+
+  fs.writeFileSync(`./openapi-spec.yml`, fileContent, {
+    encoding: "utf-8",
+  });
+}
+
+writeDocumentation();