Class OpenApiConverter

Privateswagger

PrivateaddInfo

• addInfo(
      projectData: ProjectData,
  ): { title: string; version: string; description?: string }

  Adds project information to OpenAPI info object

  Parameters

  • projectData: ProjectData

  Returns { title: string; version: string; description?: string }

PrivateaddServers

• addServers(projectData: ProjectData): { url: string; description?: string }[]

  Adds server information from project data

  Parameters

  • projectData: ProjectData

  Returns { url: string; description?: string }[]

PrivateremoveTags

• removeTags(text?: string): string

  Removes HTML tags from text

  Parameters

  • Optionaltext: string

  Returns string

PrivategroupByUrl

• groupByUrl(apidocData: ApiDocItem[]): { verbs: ApiDocItem[] }[]

  Groups API endpoints by URL

  Parameters

  • apidocData: ApiDocItem[]

  Returns { verbs: ApiDocItem[] }[]

PrivateextractPaths

• extractPaths(apidocData: ApiDocItem[]): Record<string, any>

  Extracts paths from APIDoc data

  Parameters

  • apidocData: ApiDocItem[]

  Returns Record<string, any>

PrivategeneratePathItem

• generatePathItem(verb: ApiDocItem): any

  Generates a path item for OpenAPI

  Parameters

  • verb: ApiDocItem

  Returns any

PrivateaddParameters

• addParameters(pathItem: any, verb: ApiDocItem): void

  Adds parameters to path item

  Parameters

  • pathItem: any
  • verb: ApiDocItem

  Returns void

PrivateaddRequestBody

• addRequestBody(pathItem: any, verb: ApiDocItem): void

  Adds request body for POST/PUT/PATCH methods

  Parameters

  • pathItem: any
  • verb: ApiDocItem

  Returns void

PrivateaddResponses

• addResponses(pathItem: any, verb: ApiDocItem): void

  Adds responses to path item

  Parameters

  • pathItem: any
  • verb: ApiDocItem

  Returns void

PrivategenerateSchemaFromFields

• generateSchemaFromFields(fields: any[]): any

  Generates JSON schema from APIDoc fields

  Parameters

  • fields: any[]

  Returns any

PrivateconvertType

• convertType(type: string): string

  Converts APIDoc types to OpenAPI types

  Parameters

  • type: string

  Returns string