api

import { generate } from '@readme/api'; import path from 'node:path'; import fs from 'node:fs/promises'; import { fileURLToPath } from 'node:url'; const __filename = fileURLToPath(import.meta.url); const __dirname = path.dirname(__filename); async function createDummyOpenApiSpec(specPath: string) { const dummyOpenApiSpec = { openapi: '3.0.0', info: { title: 'My API', version: '1.0.0' }, paths: { '/users': { get: { summary: 'Get all users', responses: { '200': { description: 'A list of users', content: { 'application/json': { schema: { type: 'array', items: { $ref: '#/components/schemas/User' } } } } } } } } }, components: { schemas: { User: { type: 'object', properties: { id: { type: 'string', format: 'uuid' }, name: { type: 'string' } } } } } }; await fs.writeFile(specPath, JSON.stringify(dummyOpenApiSpec, null, 2)); } async function runSdkGeneration() { const outputBaseDir = path.resolve(__dirname, 'temp-sdk-output'); await fs.mkdir(outputBaseDir, { recursive: true }); const openApiPath = path.join(outputBaseDir, 'openapi.json'); await createDummyOpenApiSpec(openApiPath); const sdkOutputDir = path.join(outputBaseDir, 'generated-sdk'); await fs.mkdir(sdkOutputDir, { recursive: true }); console.log(`Starting SDK generation...`); console.log(` OpenAPI Spec: ${openApiPath}`); console.log(` Output Dir: ${sdkOutputDir}`); // The '@readme/api' package provides a `generate` function to create SDKs // from an OpenAPI definition. It expects the path to the OpenAPI // file and the desired output directory for the generated SDK. // In v7, the generation strategy is overhauled for consistent module // resolution and types across CJS, ESM, and TypeScript. await generate(openApiPath, sdkOutputDir); console.log('SDK generation complete!'); console.log(`You can now find the generated SDK in: ${sdkOutputDir}`); console.log(`Example: const { default: sdk } = await import('${sdkOutputDir}');`); // Clean up temporary files await fs.rm(outputBaseDir, { recursive: true, force: true }); console.log(`Cleaned up temporary directory: ${outputBaseDir}`); } runSdkGeneration().catch(console.error);