OpenAPI Support Matrix

The tables below provide an overview of the OpenAPI features supported by Speakeasy.

✅ Server configuration

Name

ServerURL config

Notes

Global and per-method (include base URL and templating)

Support

✅

Swagger link

API server and base path

Authentication and security

Notes

Global and per-method

Support

✅

Swagger link

Authentication

Method generation

Notes

Support

✅

Swagger link

Model generation

Notes

Request and response

Support

✅

Swagger link

Name	Notes	Swagger link	Support
ServerURL config	Global and per-method (include base URL and templating)	API server and base path	✅
Authentication and security	Global and per-method	Authentication	✅
Method generation			✅
Model generation	Request and response		✅

⚠️ Path parameters serialization (Path parameters)

Name

Default

Notes

(style = simple, explode = false)

Support

✅

Swagger link

Parameter serialization

Basic types

Notes

Support

✅

Swagger link

Simple objects

Notes

Support

✅

Swagger link

label

Notes

Support

❌

Swagger link

matrix

Notes

Support

❌

Swagger link

Name	Notes	Swagger link	Support
Default	(style = simple, explode = false)	Parameter serialization	✅
Basic types			✅
Simple objects			✅
label			❌
matrix			❌

⚠️ Query parameters serialization (Query parameters and query)

Name

json

Notes

Support

✅

Swagger link

form

Notes

Support

✅

Swagger link

spaceDelimited

Notes

Support

✅

Swagger link

pipeDelimited

Notes

Support

✅

Swagger link

deepObject

Notes

Support

✅

Swagger link

Basic types

Notes

Support

✅

Swagger link

Simple objects

Notes

Support

✅

Swagger link

Name	Notes	Swagger link	Support
json			✅
form			✅
spaceDelimited			✅
pipeDelimited			✅
deepObject			✅
Basic types			✅
Simple objects			✅

✅ Request headers (Header)

Name

Simple (explode = true)

Notes

Support

✅

Swagger link

Simple (explode = false)

Notes

Support

✅

Swagger link

Name	Notes	Swagger link	Support
Simple (explode = true)			✅
Simple (explode = false)			✅

⚠️ Request body serialization

Name

Multipart encoding

Notes

Support

✅

Swagger link

Multipart requests

Binary

Notes

Support

✅

Swagger link

Form data

Notes

Support

✅

Swagger link

JSON

Notes

Both application/json and text/json

Support

✅

Swagger link

x-www-form-urlencoded

Notes

Including encoding, but not non-object types

Support

⚠️

Swagger link

Describing request body

Plain text

Notes

Support

✅

Swagger link

Raw byte

Notes

Support

✅

Swagger link

Handling required body

Notes

Support

✅

Swagger link

XML

Notes

Support

❌

Swagger link

Other media types

Notes

Support

❌

Swagger link

Name	Notes	Swagger link	Support
Multipart encoding		Multipart requests	✅
Binary			✅
Form data			✅
JSON	Both application/json and text/json		✅
x-www-form-urlencoded	Including encoding, but not non-object types	Describing request body	⚠️
Plain text			✅
Raw byte			✅
Handling required body			✅
XML			❌
Other media types			❌

⚠️ Response body deserialization

Name

Return StatusCode and Content-Type

Notes

Support

✅

Swagger link

JSON

Notes

Support

✅

Swagger link

Plain text

Notes

Support

✅

Swagger link

Raw byte

Notes

Support

✅

Swagger link

JSON

Notes

Support

✅

Swagger link

Other media types

Notes

Support

❌

Swagger link

Name	Notes	Swagger link	Support
Return StatusCode and Content-Type			✅
JSON			✅
Plain text			✅
Raw byte			✅
JSON			✅
Other media types			❌

✅ Media-type patterns (Media types)

✅ Data types

Name

Basic types

Notes

Support

✅

Swagger link

Data models: Data types

Enums

Notes

Support

✅

Swagger link

Number formats

Notes

float, double, int32, int64

Support

✅

Swagger link

Date-time

Notes

Support

✅

Swagger link

Binary

Notes

Support

✅

Swagger link

Arrays

Notes

Support

✅

Swagger link

Objects

Notes

Support

✅

Swagger link

Optional

Notes

Support

✅

Swagger link

Maps

Notes

Support

✅

Swagger link

Any type

Notes

Support

✅

Swagger link

OneOf, AnyOf, and AllOf

Notes

Support

⚠️ See union type support below

Swagger link

oneOf, anyOf, allOf, not

Name	Notes	Swagger link	Support
Basic types		Data models: Data types	✅
Enums			✅
Number formats	float, double, int32, int64		✅
Date-time			✅
Binary			✅
Arrays			✅
Objects			✅
Optional			✅
Maps			✅
Any type			✅
OneOf, AnyOf, and AllOf		oneOf, anyOf, allOf, not	⚠️ See union type support below

✅ Union types

Name

oneOf

Notes

For languages that don't yet have native union type support in Speakeasy, oneOf will be treated as an any type.

Language support

✅ TypeScript, Python, Go, C#, Java, PHP

allOf

Notes

To avoid construction of illogical types, Speakeasy currently constructs an object using the superset of fields from the listed schemas. In cases where the base schemas have a field name collision, Speakeasy will default to using the field from the object deepest in the list.

Language support

✅ All languages

anyOf

Notes

anyOf is treated as oneOf to avoid the bloat of combinatorial data type creation.

Language support

✅ TypeScript, Python, Go

Name	Notes	Language support
oneOf	For languages that don't yet have native union type support in Speakeasy, oneOf will be treated as an any type.	✅ TypeScript, Python, Go, C#, Java, PHP
allOf	To avoid construction of illogical types, Speakeasy currently constructs an object using the superset of fields from the listed schemas. In cases where the base schemas have a field name collision, Speakeasy will default to using the field from the object deepest in the list.	✅ All languages
anyOf	anyOf is treated as oneOf to avoid the bloat of combinatorial data type creation.	✅ TypeScript, Python, Go

✅ Miscellaneous

Name

Auxiliary files*

Notes

Support

✅

Swagger link

x-speakeasy-server-id generation

Notes

Support

✅

Swagger link

Snippet generation

Notes

Support

✅

Swagger link

README generation

Notes

Support

✅

Swagger link

Documentation generation

Notes

Support

✅

Swagger link

Name	Notes	Swagger link	Support
Auxiliary files*			✅
x-speakeasy-server-id generation			✅
Snippet generation			✅
README generation			✅
Documentation generation			✅

* Files needed for creating a fully compilable package that can be published to the relevant package manager without further changes.