docs: api reference (#1048)

* docs: api reference

* chore(docs): add peer denpendencies for redoc-cli

packages/docs/.gitignore

@@ -7,6 +7,7 @@
 # Generated files
 .docusaurus
 .cache-loader
+/static/api/index.html
 
 # Misc
 .DS_Store

packages/docs/docusaurus.config.js

@@ -64,6 +64,12 @@ const config = {
             position: 'left',
             label: 'SDK',
           },
+          {
+            href: '/api',
+            target: '_blank',
+            position: 'left',
+            label: 'API',
+          },
           {
             type: 'localeDropdown',
             position: 'right',

packages/docs/package.json

@@ -4,11 +4,12 @@
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
-    "start": "docusaurus start",
+    "start": "pnpm build:api && docusaurus start",
-    "build": "docusaurus build",
+    "build": "pnpm build:api && docusaurus build",
+    "build:api": "redoc-cli build https://logto.dev/api/swagger.json -o static/api/index.html --title 'Logto Core API Reference'",
     "swizzle": "docusaurus swizzle",
-    "deploy": "docusaurus deploy",
+    "deploy": "pnpm build:api && docusaurus deploy",
-    "clear": "docusaurus clear",
+    "clear": "rm static/api/index.html && docusaurus clear",
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
@@ -29,7 +30,11 @@
     "@tsconfig/docusaurus": "^1.0.5",
     "@types/node": "^17.0.23",
     "@types/react": "^17.0.14",
-    "typescript": "^4.6.3"
+    "typescript": "^4.6.3",
+    "redoc-cli": "^0.13.16",
+    "react-is": "^16.8.0",
+    "webpack": "^5.0.0",
+    "core-js": "^3.1.4"
   },
   "browserslist": {
     "production": [