flowingts / OpenAPIOptions

Interface: OpenAPIOptions

Definido em: src/openapi/generate.ts:9

Opções de app.openapi() (F-16).

Propriedades

docs?

optional docs?: string | boolean

Definido em: src/openapi/generate.ts:21

Swagger UI. Desligado por padrão: true serve em '/docs', uma string escolhe o path.

---

guards?

optional guards?: readonly Guard[]

Definido em: src/openapi/generate.ts:25

Rodam depois dos middlewares, como nas rotas (401/403 antes de gerar o documento).

---

host?

optional host?: string

Definido em: src/openapi/generate.ts:17

Só no openapiDocument(): documenta as rotas deste host (virtual hosts) mais as sem host (F-35). Sem host, entram só as rotas sem host. O /openapi.json servido usa o host da requisição.

---

info?

optional info?: object

Definido em: src/openapi/generate.ts:11

Padrão: { title: 'API', version: '0.0.0' }.

Assinatura de índice

[key: string]: unknown

description?

optional description?: string

title

title: string

version

version: string

---

middlewares?

optional middlewares?: readonly Middleware[]

Definido em: src/openapi/generate.ts:23

Rodam antes de servir o documento e a página, depois dos middlewares globais.

---

path?

optional path?: string

Definido em: src/openapi/generate.ts:19

Onde servir o documento JSON. Padrão: '/openapi.json'.

---

servers?

optional servers?: readonly object[]

Definido em: src/openapi/generate.ts:12