Class OpenAPIService

Hierarchy (View Summary)

GenericService
- OpenAPIService

Index

Constructors

Properties

basePath keycloak?

Methods

getApiDocs getPageUrl

Constructors

constructor

new OpenAPIService(opts?: GenericServiceOpts): OpenAPIService
Parameters
- opts: GenericServiceOpts = ...
Returns OpenAPIService
Overrides GenericService.constructor
- Defined in service/OpenAPIService/index.ts:12

Properties

`Protected` `Readonly`basePath

basePath: string

`Protected` `Optional` `Readonly`keycloak

keycloak?: Keycloak

Methods

getApiDocs

getApiDocs(
version?: OpenApiVersion,
fetchOpts?: RequestInit,
): Promise<Document<{}> | Document<{}>>
Parameters
- version: OpenApiVersion = 'v2'
- OptionalfetchOpts: RequestInit
Returns Promise<Document<{}> | Document<{}>>
- Defined in service/OpenAPIService/index.ts:18

`Protected`getPageUrl

getPageUrl(pageOpts?: PageOpts): string
Parameters
- OptionalpageOpts: PageOpts
Returns string
Inherited from GenericService.getPageUrl
- Defined in service/GenericService/index.ts:31