Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EndpointDefinition

Typed definition of an individual REST endpoint.

Users of Rest.ts normally don't interact with this type directly. Libraries will extract the relevant information from this type in order to provide a user-friendly interface for API producers or consumers.

Hierarchy

  • EndpointDefinition

Index

Properties

Optional body

body: DTO_Type

method

method: HttpMethod

Optional params

params: string[]

path

path: string[]

Optional query

response

response: DTO_Type | undefined

Generated using TypeDoc