Merge pull request #356 from authzed/add-swagger

add swagger doc

Author: miparnisari

components/swagger.tsx

@@ -0,0 +1,17 @@
+import dynamic from 'next/dynamic'
+import type { SwaggerUIProps } from 'swagger-ui-react'
+
+const SwaggerUI = dynamic(() => import('swagger-ui-react') as Promise<{ default: React.ComponentType<SwaggerUIProps> }>, { ssr: false })
+
+import 'swagger-ui-react/swagger-ui.css'
+
+export function Swagger(props: {}) {
+    return (<SwaggerUI
+        url="https://raw.githubusercontent.com/authzed/api/refs/heads/main/docs/apidocs.swagger.json"
+        deepLinking={true}
+        supportedSubmitMethods={[]}
+        tryItOutEnabled={false}
+        defaultModelsExpandDepth={-1}
+        defaultModelRendering={'model'}
+    />)
+}

globals.css

@@ -23,3 +23,11 @@ body {
   top: 0;
   left: 0;
 }
+
+.swagger-ui .information-container {
+  display: none;
+}
+
+.swagger-ui .scheme-container {
+  display: none;
+}

package.json

@@ -37,6 +37,7 @@
     "react-dom": "^18.3.1",
     "react-youtube": "^10.1.0",
     "sharp": "^0.34.0",
+    "swagger-ui-react": "^5.22.0",
     "tailwind-merge": "^2.4.0"
   },
   "devDependencies": {
@@ -54,5 +55,6 @@
     "tailwindcss": "^3.4.4",
     "typescript": "^4.9.5",
     "yaml-loader": "^0.8.1"
-  }
+  },
+  "packageManager": "pnpm@10.10.0+sha512.d615db246fe70f25dcfea6d8d73dee782ce23e2245e3c4f6f888249fb568149318637dca73c2c5c8ef2a4ca0d5657fb9567188bfab47f566d1ee6ce987815c39"
 }

pages/authzed/api/_meta.json

@@ -5,9 +5,7 @@
     "newWindow": true
   },
   "http-api": {
-    "title": "HTTP API Reference",
-    "href": "https://www.postman.com/authzed/workspace/spicedb/overview",
-    "newWindow": true
+    "title": "HTTP API Reference"
   },
   "cloud-api": {
     "title": "Cloud API Reference",

pages/authzed/api/http-api.mdx

@@ -0,0 +1,5 @@
+import {Swagger} from "../../../components/swagger";
+
+# HTTP API Documentation
+
+<Swagger />

pages/spicedb/api/_meta.json

@@ -5,7 +5,10 @@
     "newWindow": true
   },
   "http-api": {
-    "title": "HTTP API Reference",
+    "title": "HTTP API Reference"
+  },
+  "postman": {
+    "title": "Postman Collection",
     "href": "https://www.postman.com/authzed/workspace/spicedb/overview",
     "newWindow": true
   }

pages/spicedb/api/http-api.mdx

@@ -0,0 +1,5 @@
+import {Swagger} from "../../../components/swagger";
+
+# HTTP API Documentation
+
+<Swagger />