swaggerConfig.js

const swaggerJsdoc = require("swagger-jsdoc");
const yaml = require("yaml");
const fs = require("fs");

/**
 * Generate Swagger responses with custom MIME types and content
 * @param {Object} responseMap - An object mapping HTTP status codes to response details
 * @returns {Object} - Swagger-compliant responses object
 */
function generateSwaggerResponses(responseMap) {
  const responses = {};

  for (const [statusCode, { mimeType, example }] of Object.entries(responseMap)) {
    responses[statusCode] = {
      content: {
        [mimeType]: {
          schema: {
            type: typeof example === "string" ? "string" : "object", // Infer type if not explicitly set
            example, // Use the given example directly
          },
        },
      },
    };
  }

  return responses;
}

const swaggerDefinition = {
  openapi: "3.0.0",
  info: {
    title: "AJV to Swagger API",
    version: "1.0.0",
    description: "An API documentation generated from AJV schemas",
  },
  paths: {
    "/register": {
      post: {
        summary: "Register a new user",
        requestBody: {
          required: true,
          content: {
            "application/json": {
              schema: {
                type: "object",
                properties: {
                  name: { type: "string" },
                  email: { type: "string", format: "email" },
                  age: { type: "integer", minimum: 18 },
                },
                required: ["name", "email"],
              },
            },
          },
        },
        responses: generateSwaggerResponses({
          200: {
            mimeType: "application/json",
            example: { status: "ok", id: 123 },
          }
        }),
      },
    },
  },
};

const options = {
  swaggerDefinition,
  apis: ["./routes/*.js"],
};

const swaggerSpec = swaggerJsdoc(options);

// Convert JSON spec to YAML
const swaggerYaml = yaml.stringify(swaggerSpec);

// Write to a file
fs.writeFileSync("swagger.yaml", swaggerYaml, "utf8");

module.exports = swaggerSpec;