Skip to content

Commit 2dd1cca

Browse files
committed
docs(server-nestjs): add comment for baseUrl option
1 parent b35a6a8 commit 2dd1cca

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
import { AdapterBaseOptions } from "../../types";
22

33
export interface ApiHandlerOptions extends AdapterBaseOptions {
4+
/**
5+
* The base URL for the API handler. This is used to determine the base path for the API requests.
6+
* If you are using the ApiHandlerService in a route with a prefix, you should set this to the prefix.
7+
*
8+
* e.g.
9+
* without baseUrl(API handler default route):
10+
* - RPC API handler: [model]/findMany
11+
* - RESTful API handler: /:type
12+
*
13+
* with baseUrl(/api/crud):
14+
* - RPC API handler: /api/crud/[model]/findMany
15+
* - RESTful API handler: /api/crud/:type
16+
*/
417
baseUrl?: string;
518
}

0 commit comments

Comments
 (0)