feat: api documentation

SeanCassiere · Jun 23, 2024 · 7c43bdb · 7c43bdb
1 parent 288ebac
commit 7c43bdb
Show file tree

Hide file tree

Showing 12 changed files with 4,425 additions and 137 deletions.
diff --git a/.gitignore b/.gitignore
@@ -134,4 +134,5 @@ dist
 
 #
 .DS_Store
-ignore/
+ignore/
+public/static/openapi.v*
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # Simple Logging Server
 
+https://github.com/scalar/scalar/tree/main/packages/hono-api-reference
+
 This is a dead simple log server that allows you to log messages to a persisted database.
 
 ## Development

diff --git a/package.json b/package.json
@@ -42,6 +42,7 @@
   "dependencies": {
     "@hono/node-server": "^1.11.4",
     "@paralleldrive/cuid2": "^2.2.2",
+    "@scalar/hono-api-reference": "^0.5.77",
     "dotenv": "^16.4.5",
     "drizzle-orm": "^0.31.2",
     "hono": "^4.4.7",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/public/robots.txt b/public/robots.txt
@@ -0,0 +1,9 @@
+# Allow all robots to crawl the entire site
+User-agent: *
+Disallow:
+
+# But exclude the following directories
+Disallow: /static/
+
+# Set the crawl rate to 10 requests per second
+Crawl-delay: 10
-Original file line number
+Diff line change
@@ Expand Up / @@ -134,4 +134,5 @@ dist @@
     #
     .DS_Store
-    ignore/
+    ignore/
+    public/static/openapi.v*