nswag

import { execSync } from 'child_process'; import * as fs from 'fs'; import * as path from 'path'; // This quickstart demonstrates how to use the NSwag command-line tool // to generate a TypeScript client from an existing OpenAPI (Swagger) specification. // Replace 'your-api-swagger.json' with your actual spec file or URL. // This assumes nswag is installed globally (`npm install -g nswag`) or available via npx. const swaggerSpecPath = path.join(__dirname, 'temp-api-swagger.json'); const outputClientPath = path.join(__dirname, 'generated-api-client.ts'); // Specify the .NET runtime NSwag should use. Common options: Net80, Net90, Net100, WinX64. // Ensure a compatible .NET runtime is installed on your system. const runtime = process.env.NSWAG_RUNTIME ?? 'Net80'; // Create a dummy OpenAPI spec for demonstration if it doesn't exist if (!fs.existsSync(swaggerSpecPath)) { console.log(`Creating a dummy OpenAPI spec at ${swaggerSpecPath}`); const dummySpec = { openapi: '3.0.0', info: { title: 'Dummy API', version: '1.0' }, paths: { '/items': { get: { summary: 'Get all items', responses: { '200': { description: 'A list of items', content: { 'application/json': { schema: { type: 'array', items: { type: 'string' } } } } } } } } }, components: {} }; fs.writeFileSync(swaggerSpecPath, JSON.stringify(dummySpec, null, 2)); } try { console.log(`Generating TypeScript client from ${swaggerSpecPath} using runtime ${runtime}...`); // The 'nswag' command is resolved from PATH (global install) or node_modules/.bin (npx) const command = `npx nswag openapi2tsclient /input:${swaggerSpecPath} /output:${outputClientPath} /runtime:${runtime}`; execSync(command, { stdio: 'inherit' }); console.log(`TypeScript client generated successfully to ${outputClientPath}`); console.log('\n--- Generated Client Excerpt ---'); const clientContent = fs.readFileSync(outputClientPath, 'utf8'); console.log(clientContent.substring(0, 500) + '...\n'); // Show first 500 chars } catch (error: any) { console.error('Error generating client:', error.message); console.error('Please ensure NSwag is installed globally (`npm install -g nswag`) or available via npx, and a compatible .NET runtime is installed (e.g., .NET 8 SDK).'); process.exit(1); } finally { // Clean up dummy spec and generated client if (fs.existsSync(swaggerSpecPath)) fs.unlinkSync(swaggerSpecPath); if (fs.existsSync(outputClientPath)) fs.unlinkSync(outputClientPath); console.log('Cleaned up temporary files.'); }