Skip to main content

ApiRouter

Home > @backstage/backend-openapi-utils > ApiRouter

Typed Express router based on an OpenAPI 3.1 spec.

Signature:

export interface ApiRouter<Doc extends RequiredDoc> extends Router 

Extends: Router

Properties

Property

Modifiers

Type

Description

all

DocRequestMatcher<Doc, this, 'all'>

delete

DocRequestMatcher<Doc, this, 'delete'>

get

DocRequestMatcher<Doc, this, 'get'>

head

DocRequestMatcher<Doc, this, 'head'>

options

DocRequestMatcher<Doc, this, 'options'>

patch

DocRequestMatcher<Doc, this, 'patch'>

post

DocRequestMatcher<Doc, this, 'post'>

put

DocRequestMatcher<Doc, this, 'put'>