next-openapi-gen/dist/openapi-template.js

Automatically generate OpenAPI 3.0 documentation from Next.js projects, with support for Zod schemas and TypeScript types.

export default {
    openapi: "3.0.0",
    info: {
        title: "API Documentation",
        version: "1.0.0",
        description: "This is the OpenAPI specification for your project.",
    },
    servers: [
        {
            url: "http://localhost:3000/api",
            description: "Local development server",
        },
    ],
    components: {
        securitySchemes: {
            BearerAuth: {
                type: "http",
                scheme: "bearer",
                bearerFormat: "JWT",
            },
        },
    },
    defaultResponseSet: "common",
    responseSets: {
        common: ["400", "500"],
        auth: ["400", "401", "403", "500"],
        public: ["400", "500"],
    },
    errorConfig: {
        template: {
            type: "object",
            properties: {
                error: {
                    type: "string",
                    example: "{{ERROR_MESSAGE}}",
                },
                code: {
                    type: "string",
                    example: "{{ERROR_CODE}}",
                },
            },
        },
        codes: {
            "400": {
                description: "Bad Request",
                variables: {
                    ERROR_MESSAGE: "Invalid request parameters",
                    ERROR_CODE: "BAD_REQUEST",
                },
            },
            "401": {
                description: "Unauthorized",
                variables: {
                    ERROR_MESSAGE: "Authentication required",
                    ERROR_CODE: "UNAUTHORIZED",
                },
            },
            "403": {
                description: "Forbidden",
                variables: {
                    ERROR_MESSAGE: "Access denied",
                    ERROR_CODE: "FORBIDDEN",
                },
            },
            "404": {
                description: "Not Found",
                variables: {
                    ERROR_MESSAGE: "Resource not found",
                    ERROR_CODE: "NOT_FOUND",
                },
            },
            "409": {
                description: "Conflict",
                variables: {
                    ERROR_MESSAGE: "Resource already exists",
                    ERROR_CODE: "CONFLICT",
                },
            },
            "500": {
                description: "Internal Server Error",
                variables: {
                    ERROR_MESSAGE: "An unexpected error occurred",
                    ERROR_CODE: "INTERNAL_ERROR",
                },
            },
        },
    },
    apiDir: "./src/app/api",
    schemaDir: "./src",
    schemaType: "zod", // or "typescript"
    docsUrl: "api-docs",
    ui: "scalar",
    outputFile: "openapi.json",
    outputDir: "./public",
    includeOpenApiRoutes: false,
    debug: false,
};