• SpecificationApi - functional programming interface

    Parameters

    Returns {
        getDocs(options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>;
        getSwagger(options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    }

    • getDocs:function
      • Swagger/OpenAPI 3.0 specification generated documents.

        Parameters

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

        Summary

        Documentation

        Throws

    • getSwagger:function
      • Returns human and machine readable swagger/openapi specification

        Parameters

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

        Summary

        Swagger File

        Throws

    Export

Generated using TypeDoc