UNPKG

azure-functions-swagger-ui

Version:

A simple npm module that integrates Swagger UI into Azure Functions, providing a user-friendly interface to visualize and interact with your API endpoints. Perfect for documenting and testing Azure Functions with minimal setup.

24 lines (23 loc) 991 B
import { SwaggerOptions } from "./makeHtml"; declare const fileMap: Map<string, { fileName: string; contentType: string; }>; declare const custom_maps: { [key: string]: Map<string, { fileName: string; contentType: string; }>; }; declare const clear_custom_maps: (key?: string) => void; /** * * @param name string * @param swaggerOptions SwaggerOptions, { doc_path, title?, favicon16?, favicon32?, css_path?, display_topbar? : 0 | 1 | 2 | 3} * @param is_swagger_jsdoc_object boolean | Array<boolean>, set to true if the doc_path is a jsdoc object or boolean array of the same length as doc_path specifying which element of doc_path is a jsdoc object * * * This function updates the custom_map with the custom files specified in the swaggerOptions */ declare function updateCustomMap(name: string, swaggerOptions: SwaggerOptions, is_swagger_jsdoc_object: boolean | boolean[]): void; export { fileMap, custom_maps, updateCustomMap, clear_custom_maps };