API reference / @chanx-js/server / core / AsyncAPIServeOptions

Interface: AsyncAPIServeOptions

Defined in: packages/server/src/asyncapi-http.ts:6

Options for asyncapiHandler(): the document's, plus where to serve it.

Extends

• AsyncAPIOptions

Properties

contact?

optional contact?: object;

Defined in: packages/server/src/asyncapi.ts:77

email?

optional email?: string;

name?

optional name?: string;

url?

optional url?: string;

Inherited from

AsyncAPIInfo.contact

---

description?

optional description?: string;

Defined in: packages/server/src/asyncapi.ts:20

Defaults to an empty string.

Inherited from

AsyncAPIOptions.description

---

docs?

optional docs?: AsyncAPIDocsAssets;

Defined in: packages/server/src/asyncapi-http.ts:10

Where the docs page loads its script and stylesheet: a pinned CDN release by default.

---

externalDocs?

optional externalDocs?: AsyncAPIExternalDocs;

Defined in: packages/server/src/asyncapi.ts:80

Inherited from

AsyncAPIInfo.externalDocs

---

license?

optional license?: object;

Defined in: packages/server/src/asyncapi.ts:78

name

name: string;

url?

optional url?: string;

Inherited from

AsyncAPIInfo.license

---

path?

optional path?: string;

Defined in: packages/server/src/asyncapi-http.ts:8

The docs page's path; the document is served at it plus .json and .yaml. Defaults to /asyncapi.

---

securitySchemes?

optional securitySchemes?: Record<string, AsyncAPISecurityScheme>;

Defined in: packages/server/src/asyncapi.ts:28

AsyncAPI Security Scheme Objects by name; one replaces a credentials one of its name.

Inherited from

AsyncAPIOptions.securitySchemes

---

serverProtocol?

optional serverProtocol?: string;

Defined in: packages/server/src/asyncapi.ts:24

ws or wss. Defaults to ws.

Inherited from

AsyncAPIOptions.serverProtocol

---

servers?

optional servers?: Record<string, AsyncAPIServer>;

Defined in: packages/server/src/asyncapi.ts:26

AsyncAPI Server Objects by name, in place of serverUrl and serverProtocol.

Inherited from

AsyncAPIOptions.servers

---

serverUrl?

optional serverUrl?: string;

Defined in: packages/server/src/asyncapi.ts:22

The server's host, such as api.example.com. Defaults to localhost:8000.

Inherited from

AsyncAPIOptions.serverUrl

---

tags?

optional tags?: AsyncAPITag[];

Defined in: packages/server/src/asyncapi.ts:79

Inherited from

AsyncAPIInfo.tags

---

termsOfService?

optional termsOfService?: string;

Defined in: packages/server/src/asyncapi.ts:76

A URL to the API's terms of service.

Inherited from

AsyncAPIInfo.termsOfService

---

title?

optional title?: string;

Defined in: packages/server/src/asyncapi.ts:16

Defaults to AsyncAPI Documentation.

Inherited from

AsyncAPIOptions.title

---

version?

optional version?: string;

Defined in: packages/server/src/asyncapi.ts:18

The API's version. Defaults to 1.0.0.

Inherited from

AsyncAPIOptions.version