Function writeOpenApiSpec

writeOpenApiSpec(options: OpenApiOptions, outputPath: string): OpenApiDocument

Generate an OpenAPI spec and write it to a file.

Parameters

options: OpenApiOptions
Same options as generateOpenApiSpec().
outputPath: string
File path to write the JSON spec to.

Returns OpenApiDocument

The generated spec document.

Example

import { writeOpenApiSpec } from '@cleverbrush/server-openapi';
import { createServer, endpoint } from '@cleverbrush/server';

const builder = createServer()
  .handle(endpoint.get('/api/health'), () => ({ ok: true }));

writeOpenApiSpec(
  {
    registrations: builder.getRegistrations(),
    info: { title: 'My API', version: '1.0.0' }
  },
  './openapi.json'
);