Options
All
  • Public
  • Public/Protected
  • All
Menu

next-swagger-doc

Index

Functions

Functions

createSwaggerSpec

  • createSwaggerSpec(__namedParameters?: SwaggerOptions): object

  • Create swagger JSON

    Parameters

    • __namedParameters: SwaggerOptions = defaultOptions

    Returns object

    Swagger JSON Spec

withSwagger

  • withSwagger(__namedParameters?: SwaggerOptions): () => (_req: NextApiRequest, res: NextApiResponse<any>) => void

  • withSwagger middleware

    Parameters

    • __namedParameters: SwaggerOptions = defaultOptions

    Returns () => (_req: NextApiRequest, res: NextApiResponse<any>) => void

      • (): (_req: NextApiRequest, res: NextApiResponse<any>) => void

      • Returns (_req: NextApiRequest, res: NextApiResponse<any>) => void

          • (_req: NextApiRequest, res: NextApiResponse<any>): void

          • Parameters

            • _req: NextApiRequest
            • res: NextApiResponse<any>

            Returns void

Generated using TypeDoc