Merge pull request #895 from samchon/features/api

API Documents by TypeDoc

README.md

@@ -18,8 +18,8 @@ Nestia is a set of helper libraries for NestJS, supporting below features:
     - SDK library generator for clients
     - Mockup Simulator for client applications
     - Automatic E2E test functions generator
-  - `@nestia/migrate`: Migration from Swagger to NestJS
-  - `@nestia/editor`: Online TypeScript Swagger Editor
+  - `@nestia/migrate`: OpenAPI generator from Swagger to NestJS
+  - `@nestia/editor`: Swagger-UI with Online TypeScript Editor
   - `nestia`: Just CLI (command line interface) tool
 
 > **Note**

website/.gitignore

@@ -1,3 +1,4 @@
 .next
 node_modules/
-out/
+out/
+public/api/

website/next.config.js

@@ -10,5 +10,11 @@ const nextConfig = {
     unoptimized: true,
   },
   output: "export",
+  rewrites: async () => [
+    {
+      source: "/api",
+      destination: "/api/index.html",
+    },
+  ],
 };
 module.exports = nextConfig;

website/package.json

@@ -4,7 +4,7 @@
   "description": "Nestia Guide Documents",
   "private": true,
   "scripts": {
-    "build": "rimraf .next && rimraf .out && next build && next-sitemap",
+    "build": "rimraf .next && rimraf .out && typedoc && next build && next-sitemap",
     "deploy": "node deploy",
     "dev": "next dev"
   },
@@ -43,6 +43,7 @@
     "gh-pages": "^5.0.0",
     "next-sitemap": "^4.2.3",
     "rimraf": "^5.0.0",
+    "typedoc": "^0.25.13",
     "typescript": "^5.4.5"
   }
 }

website/pages/docs/_meta.json

@@ -16,6 +16,11 @@
     "type": "separator",
     "title": "🔗 Appendix"
   },
+  "api": {
+    "title": "API Documents",
+    "href": "/api",
+    "newWindow": false
+  },
   "benchmark": {
     "title": "⇲ Benchmark Result",
     "href": "https://github.com/samchon/nestia/tree/master/benchmark/results/AMD%20Ryzen%209%207940HS%20w%20Radeon%20780M%20Graphics",

website/pages/docs/index.mdx

@@ -54,8 +54,8 @@ Nestia is a set of helper libraries for [NestJS](https://docs.nestjs.com), suppo
     - SDK library generator for clients
     - Mockup Simulator for client developers
     - Automatic E2E test functions generator
-  - `@nestia/migrate`: Migration from Swagger to NestJS
-  - `@nestia/editor`: Online TypeScript Swagger Editor
+  - `@nestia/migrate`: OpenAPI generator from Swagger to NestJS
+  - `@nestia/editor`: Swagger-UI with Online TypeScript Editor
   - `nestia`: Just CLI (command line interface) tool
 
 <br/>

website/typedoc.json

@@ -0,0 +1,7 @@
+{
+  "tsconfig": "../packages/core/tsconfig.json",
+  "entryPoints": [
+    "../packages/core/src/index.ts",
+  ],
+  "out": "./public/api"
+}