katax-cli 1.3.1 → 1.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/commands/generate-docs.d.ts.map +1 -1
- package/dist/commands/generate-docs.js +46 -11
- package/dist/commands/generate-docs.js.map +1 -1
- package/dist/commands/init.d.ts.map +1 -1
- package/dist/commands/init.js +224 -24
- package/dist/commands/init.js.map +1 -1
- package/dist/services/openapi-generator.service.d.ts +9 -1
- package/dist/services/openapi-generator.service.d.ts.map +1 -1
- package/dist/services/openapi-generator.service.js +268 -68
- package/dist/services/openapi-generator.service.js.map +1 -1
- package/dist/templates/generators/swagger-template.d.ts +2 -2
- package/dist/templates/generators/swagger-template.d.ts.map +1 -1
- package/dist/templates/generators/swagger-template.js +10 -7
- package/dist/templates/generators/swagger-template.js.map +1 -1
- package/dist/types/index.d.ts +5 -0
- package/dist/types/index.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export declare function generateSwaggerSetup(): string;
|
|
2
|
-
export declare function generateSwaggerReadme(): string;
|
|
1
|
+
export declare function generateSwaggerSetup(defaultPort?: string): string;
|
|
2
|
+
export declare function generateSwaggerReadme(defaultPort?: string): string;
|
|
3
3
|
//# sourceMappingURL=swagger-template.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"swagger-template.d.ts","sourceRoot":"","sources":["../../../src/templates/generators/swagger-template.ts"],"names":[],"mappings":"AAKA,wBAAgB,oBAAoB,
|
|
1
|
+
{"version":3,"file":"swagger-template.d.ts","sourceRoot":"","sources":["../../../src/templates/generators/swagger-template.ts"],"names":[],"mappings":"AAKA,wBAAgB,oBAAoB,CAAC,WAAW,GAAE,MAAe,GAAG,MAAM,CAmDzE;AAED,wBAAgB,qBAAqB,CAAC,WAAW,GAAE,MAAe,GAAG,MAAM,CAuE1E"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export function generateSwaggerSetup() {
|
|
1
|
+
export function generateSwaggerSetup(defaultPort = "3000") {
|
|
2
2
|
return `import swaggerUi from 'swagger-ui-express';
|
|
3
3
|
import { Express } from 'express';
|
|
4
4
|
import fs from 'fs';
|
|
@@ -40,22 +40,25 @@ export function setupSwagger(app: Express): void {
|
|
|
40
40
|
res.send(swaggerDocument);
|
|
41
41
|
});
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
const configuredServer = swaggerDocument?.servers?.[0]?.url as string | undefined;
|
|
44
|
+
const configuredPortMatch = configuredServer?.match(/localhost:(\\d+)/);
|
|
45
|
+
const port = process.env.PORT || configuredPortMatch?.[1] || '${defaultPort}';
|
|
46
|
+
console.log(\`📖 API Documentation available at: http://localhost:\${port}/docs\`);
|
|
44
47
|
} catch (error) {
|
|
45
48
|
console.error('Failed to setup Swagger:', error);
|
|
46
49
|
}
|
|
47
50
|
}
|
|
48
51
|
`;
|
|
49
52
|
}
|
|
50
|
-
export function generateSwaggerReadme() {
|
|
53
|
+
export function generateSwaggerReadme(defaultPort = "3000") {
|
|
51
54
|
return `# API Documentation
|
|
52
55
|
|
|
53
56
|
## Swagger UI
|
|
54
57
|
|
|
55
58
|
Interactive API documentation is available at:
|
|
56
59
|
|
|
57
|
-
- **Development**: http://localhost
|
|
58
|
-
- **OpenAPI Spec**: http://localhost
|
|
60
|
+
- **Development**: http://localhost:${defaultPort}/docs
|
|
61
|
+
- **OpenAPI Spec**: http://localhost:${defaultPort}/openapi.json
|
|
59
62
|
|
|
60
63
|
## Features
|
|
61
64
|
|
|
@@ -74,7 +77,7 @@ Interactive API documentation is available at:
|
|
|
74
77
|
npm run dev
|
|
75
78
|
|
|
76
79
|
# Open browser
|
|
77
|
-
open http://localhost
|
|
80
|
+
open http://localhost:${defaultPort}/docs
|
|
78
81
|
\`\`\`
|
|
79
82
|
|
|
80
83
|
### Regenerate Documentation
|
|
@@ -91,7 +94,7 @@ katax generate docs --force
|
|
|
91
94
|
|
|
92
95
|
### Export to Postman
|
|
93
96
|
|
|
94
|
-
1. Open http://localhost
|
|
97
|
+
1. Open http://localhost:${defaultPort}/openapi.json
|
|
95
98
|
2. Copy the JSON
|
|
96
99
|
3. In Postman: File → Import → Raw Text → Paste
|
|
97
100
|
4. ✅ All endpoints imported!
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"swagger-template.js","sourceRoot":"","sources":["../../../src/templates/generators/swagger-template.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,oBAAoB;
|
|
1
|
+
{"version":3,"file":"swagger-template.js","sourceRoot":"","sources":["../../../src/templates/generators/swagger-template.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,oBAAoB,CAAC,cAAsB,MAAM;IAC/D,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oEA2C2D,WAAW;;;;;;CAM9E,CAAC;AACF,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,cAAsB,MAAM;IAChE,OAAO;;;;;;sCAM6B,WAAW;uCACV,WAAW;;;;;;;;;;;;;;;;;;;wBAmB1B,WAAW;;;;;;;;;;;;;;;;;2BAiBR,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;CA0BrC,CAAC;AACF,CAAC"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -10,10 +10,15 @@ export interface ProjectConfig {
|
|
|
10
10
|
orm?: "none" | "prisma" | "typeorm";
|
|
11
11
|
port: number;
|
|
12
12
|
useKataxServiceManager?: boolean;
|
|
13
|
+
kataxMode?: "singleton" | "instance";
|
|
13
14
|
useRedis?: boolean;
|
|
14
15
|
useWebSocket?: boolean;
|
|
15
16
|
useSeparateSocketPort?: boolean;
|
|
16
17
|
socketPort?: number;
|
|
18
|
+
useRegistry?: boolean;
|
|
19
|
+
registryMode?: "none" | "url" | "handler";
|
|
20
|
+
registryUrl?: string;
|
|
21
|
+
useLifecycleHooks?: boolean;
|
|
17
22
|
initGit?: boolean;
|
|
18
23
|
redisConfig?: {
|
|
19
24
|
host?: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IAC7B,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,YAAY,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IACvD,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAChC,UAAU,EAAE,YAAY,GAAG,MAAM,CAAC;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,EAAE,CAAC,EAAE,MAAM,CAAC;KACb,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;CACH;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,OAAO,CAAC;IACvB,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,CAAC,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC,EAAE,CAAC;CAC5D;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC9E,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,cAAc,CAAC,EAAE;QACf,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;QACrC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EACA,WAAW,GACX,WAAW,GACX,KAAK,GACL,KAAK,GACL,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,CAAC;IACb,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;CAClB"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IAC7B,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,YAAY,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IACvD,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAChC,UAAU,EAAE,YAAY,GAAG,MAAM,CAAC;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,SAAS,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAAC;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,EAAE,CAAC,EAAE,MAAM,CAAC;KACb,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;CACH;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,OAAO,CAAC;IACvB,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,CAAC,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC,EAAE,CAAC;CAC5D;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC9E,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,cAAc,CAAC,EAAE;QACf,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;QACrC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EACA,WAAW,GACX,WAAW,GACX,KAAK,GACL,KAAK,GACL,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,CAAC;IACb,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;CAClB"}
|