Method generate

packages/openapi/src/openapi-generator.ts:105–188

* Generates OpenAPI specifications from oRPC routers/contracts. * * @see https://orpc.dev/docs/openapi/openapi-specification OpenAPI Specification Docs

(
    router: AnyContractRouter | AnyRouter,
    { customErrorResponseBodySchema, commonSchemas, filter: baseFilter, exclude, ...baseDoc }: OpenAPIGeneratorGenerateOptions = {},
  )

   * @see {@link https://orpc.dev/docs/openapi/openapi-specification OpenAPI Specification Docs}
   */
  async generate(
    router: AnyContractRouter | AnyRouter,
    { customErrorResponseBodySchema, commonSchemas, filter: baseFilter, exclude, ...baseDoc }: OpenAPIGeneratorGenerateOptions = {},
  ): Promise<OpenAPI.Document> {
    const filter = baseFilter
      ?? (({ contract, path }: TraverseContractProcedureCallbackOptions) => {
        return !(exclude?.(contract, path) ?? false)
      })

    const doc: OpenAPI.Document = {
      ...clone(baseDoc),
      info: baseDoc.info ?? { title: 'API Reference', version: '0.0.0' },
      openapi: '3.1.1',
    } as OpenAPI.Document

    const { baseSchemaConvertOptions, undefinedErrorJsonSchema } = await this.#resolveCommonSchemas(doc, commonSchemas)

    const contracts: TraverseContractProcedureCallbackOptions[] = []

    await resolveContractProcedures({ path: [], router }, (traverseOptions) => {
      if (!value(filter, traverseOptions)) {
        return
      }

      contracts.push(traverseOptions)
    })

    const errors: string[] = []

    for (const { contract, path } of contracts) {
      const stringPath = path.join('.')

      try {
        const def = contract['~orpc']

        const method = toOpenAPIMethod(fallbackContractConfig('defaultMethod', def.route.method))
        const httpPath = toOpenAPIPath(def.route.path ?? toHttpPath(path))

        let operationObjectRef: OpenAPI.OperationObject

        if (def.route.spec !== undefined && typeof def.route.spec !== 'function') {
          operationObjectRef = def.route.spec
        }
        else {
          operationObjectRef = {
            operationId: def.route.operationId ?? stringPath,
            summary: def.route.summary,
            description: def.route.description,
            deprecated: def.route.deprecated,
            tags: def.route.tags?.map(tag => tag),
          }

          await this.#request(doc, operationObjectRef, def, baseSchemaConvertOptions)
          await this.#successResponse(doc, operationObjectRef, def, baseSchemaConvertOptions)
          await this.#errorResponse(operationObjectRef, def, baseSchemaConvertOptions, undefinedErrorJsonSchema, customErrorResponseBodySchema)
        }

        if (typeof def.route.spec === 'function') {