OpenApiRouteConfiguration:
    | { useInOpenApi: false }
    | { responses: OpenApiResponse[]; tags: string[]; useInOpenApi: true }

Configuration on how to handle open api for the route.

Type declaration

  • { useInOpenApi: false }
    • useInOpenApi: false

      Whether or not the route should be displayed in the open api explorer.

  • { responses: OpenApiResponse[]; tags: string[]; useInOpenApi: true }
    • responses: OpenApiResponse[]

      The possible responses in the open api format for the route.

    • tags: string[]

      Tags to be used by open api.

    • useInOpenApi: true

      Whether or not the route should be displayed in the open api explorer.