Skip to main content

CodeGen FAQs

How to create a single SDK from multiple API specification definitions?​

If you have multiple APIs, you can stitch them up into a single API spec and use that specification to create a single SDK.

In APIMatic definition, what do API and an endpoint equate to?​

  • API: API is the API specification that contains endpoints and models e.g an open API file. You can group as many endpoints as you'd like in a single API specification and call them as a single API. For APIMatic CodeGen, 1 API = 1 API spec (swagger, RAML, etc.)
  • Endpoint: 1 unique HTTP request to a server. For instance, 1 post request and 1 get request are 2 unique API endpoints.

Do SDKs support GraphQL, streaming APIs or AsyncAPI?​

SDK generation doesn't support GraphQL or AsyncAPI.

Streaming APIs are partially supported. Endpoints that stream their response over Server-Sent Events (SSE) are currently supported in TypeScript and .NET (v4 beta) SDKs only.

Which discriminators are supported in SDKs?​

We support allOf, oneOf and anyOf.

Why do example values for some parameters not show up in code even though valid examples are added in the spec?​

By default, SDKs don't show example values for optional parameters. To enable this feature, you can use the GenerateExamplesForOptionalFields CodeGen setting.

How does the GitHub deployment work?​

Publishing an SDK to GitHub is quite seamless. Simply provide access to your GitHub account and we can either push the source code to a repository of your choice or automatically create a new repository under your account. For more details refer to our Publishing documentation.