How to generate Open API spec

[skobak]

Hi,
How to use it? I specified the experimental in a config, but what is a next step to generate Open Api Specs?

export default defineNitroConfig({
  experimental: {
    openAPI: true,
  },
});

Br,
Alex

[nickspaargaren]

Run npm run dev / nitro dev and open up http://localhost:3000/_nitro/swagger.

Spec is available at http://localhost:3000/_nitro/openapi.json

[0fatihyildiz]

I can only use it on the development side. How can I deploy it to production?

[nickspaargaren]

Sorry, there is no production mode (yet). But @pi0 is working on it here.

[j0rgedev]

To point out, the new route is http://localhost:3000/_swagger. I was struggling a little bit hehe

[maximedotair]

To point out, the new route is http://localhost:3000/_swagger. I was struggling a little bit hehe

YOU SAVE ME !!! I'm on it since 3 weeks, the new route is the solution

[maximersetec]

Question

Is it possible to configure Nitro OpenAPI to use a generator from @asteasolutions/zod-to-openapi to automatically add OpenAPI objects to one or more routes?

Example Code

import { extendZodWithOpenApi, OpenApiGeneratorV3 } from '@asteasolutions/zod-to-openapi';
import { z } from 'zod';

extendZodWithOpenApi(z);

const fieldDefinitions = {
  'title': {
    label: 'Project name',
    placeholder: 'Project name',
    validation: z
      .string()
      .min(1, "Project name is required")
      .openapi({ description: 'Project name' }),
  },
  'case-number': {
    label: 'Case-number',
    placeholder: 'Case-number',
    validation: z
      .string()
      .min(1, "Case-number is required")
      .openapi({ description: 'Case-number' }),
  },
  'case-manager': {
    label: 'Case-manager',
    placeholder: 'Case-manager',
    validation: z
      .string()
      .min(1, "Case-manager is required")
      .openapi({ description: 'Case-manager' }),
  },
  'contributor': {
    label: 'Contributor',
    placeholder: 'Contributor',
    validation: z
      .string()
      .min(1, "Contributor is required")
      .openapi({ description: 'Project contributor' }),
  },
};

export const metadataSchema = z
  .object(
    Object.fromEntries(
      Object.entries(fieldDefinitions).map(([key, { validation }]) => [
        key,
        validation,
      ])
    )
  )
  .openapi('Metadata');

export const formFields = Object.entries(fieldDefinitions).map(
  ([key, { label, placeholder }]) => ({
    id: key,
    label,
    type: 'text',
    placeholder,
  })
);

const generator = new OpenApiGeneratorV3([metadataSchema]);