TypeScript Feature Reference

Authentication

NameSupportDocsNotes
HTTP BasicDocs
API Key
(bearer, header, cookie, query)
Docs
OAuth
implicit flow
Docs
OAuth
refresh token flow
✅ using security callbacksDocs
OAuth
client credentials flow
✅ using hooksDocs
mTLS🏗️ PartialDocs

Server Configuration

NameSupportDocsNotes
URL Templatingdefining variables
Multiple serverx-speakeasy-server-id extension
Describe server
outside your spec
serverUrl config

Data Types

Basic Types

NameSupportDocsNotes
Numbersdata-types (opens in a new tab)float, double, int32, int64
Stringsdata-types (opens in a new tab)
Date Timedata-types (opens in a new tab)
Booleandata-types (opens in a new tab)
Binarydata-types (opens in a new tab)
Enumsdata-types (opens in a new tab)
Arraysdata-types (opens in a new tab)
Mapsdata-types (opens in a new tab)
Objectsdata-types (opens in a new tab)
Anydata-types (opens in a new tab)
Nulldata-types (opens in a new tab)

Polymorphism

NameSupportDocsNotes
Union TypesUsing oneOf (opens in a new tab)anyOf is treated as oneOf and will create a union type object.
Intersection Types🏗️ PartialUsing allOf (opens in a new tab)

Methods

NameSupportDocsNotes
Namespacinggrouping operations
Multi-level Namespacingmulti-level grouping
Custom namingx-speakeasy-name-override extension
Exclude Methodsx-speakeasy-ignore extension
Deprecationthe deprecate flag

Parameters

NameSupportDocsNotes
Pass Inlineflattening parameters
Pass via Request Objectrequest object
Exclude Parametersx-speakeasy-ignore extension
Deprecate Parametersthe deprecate flag
Define globallyglobal parameters

Path Parameters Serialization

NameSupportDocsNotes
Default
(style = simple, explode = false)
Swagger Docs (opens in a new tab)
Basic typesSwagger Docs (opens in a new tab)
Simple objectsSwagger Docs (opens in a new tab)
label & matrixSwagger Docs (opens in a new tab)

Query Parameters Serialization

NameSupportDocsNotes
jsonSwagger Docs (opens in a new tab)
formSwagger Docs (opens in a new tab)
spaceDelimitedSwagger Docs (opens in a new tab)
pipeDelimitedSwagger Docs (opens in a new tab)
deepObjectSwagger Docs (opens in a new tab)
Basic typesSwagger Docs (opens in a new tab)
Simple objectsSwagger Docs (opens in a new tab)

Requests

NameSupportDocsNotes
Request headersSwagger Docs (opens in a new tab)
Request retriesretries
jsonSwagger Docs (opens in a new tab)Both application/json and text/json
form dataSwagger Docs (opens in a new tab)
binarySwagger Docs (opens in a new tab)
raw byteSwagger Docs (opens in a new tab)
plain textSwagger Docs (opens in a new tab)
x-www-form-urlencoded🏗️ PartialSwagger Docs (opens in a new tab)Including encoding, but not non-object types
XMLSwagger Docs (opens in a new tab)
Other media typesSwagger Docs (opens in a new tab)

Responses

NameSupportDocsNotes
Paginationx-speakeasy-pagination extension
Custom Errorsx-speakeasy-errors extension
jsonSwagger Docs (opens in a new tab)
plain textSwagger Docs (opens in a new tab)
binarySwagger Docs (opens in a new tab)
raw byteSwagger Docs (opens in a new tab)
XMLSwagger Docs (opens in a new tab)
Other media typesSwagger Docs (opens in a new tab)

Documentation

NameSupportDocsNotes
README generationREADME generation
Usage Snippet generationsnippet generation
Documentation generationdocumentation generation
CHANGELOG generationchangelog generation