Function generateDocumentation

packages/axe-api/src/Builders/SwaggerBuilder.ts:549–682

()

};

const generateDocumentation = async () => {
  const docs = DocumentationService.getInstance();
  const api = APIService.getInstance();

  let baseSchema = {
    info: {
      title: "Axe API",
      description: "Edit your swagger/index.ts file",
    },
    servers: [
      {
        url: "http://localhost:3000",
      },
    ],
  };

  const swaggerBasePath = path.join(api.appFolder, "swagger");
  if (
    fs.existsSync(`${swaggerBasePath}.ts`) ||
    fs.existsSync(`${swaggerBasePath}.js`)
  ) {
    const { default: userDefinedSchema } = await import(swaggerBasePath);
    baseSchema = userDefinedSchema;
  }

  const schemas: any = {};
  const requestBodies: any = {};
  const firstVersion = api.versions.at(0);

  if (!firstVersion) {
    throw new Error("The version is not found!");
  }

  for (const model of firstVersion.modelList.get()) {
    const properties: any = {};
    for (const column of model.columns) {
      properties[column.name] = {
        type: toPropertyType(column.data_type),
        format: column.data_type,
      };
    }
    schemas[model.name] = {
      type: "object",
      properties,
    };

    if (model.instance.handlers.includes(HandlerTypes.INSERT)) {
      requestBodies[`${model.name}${pascalCase(HttpMethods.POST)}Body`] = {
        type: "object",
        properties: toFillableFieldProperties(model),
      };
    }

    if (model.instance.handlers.includes(HandlerTypes.UPDATE)) {
      requestBodies[`${model.name}${pascalCase(HttpMethods.PUT)}Body`] = {
        type: "object",
        properties: toFillableFieldProperties(model),
      };