Customize Namespaces

When you're exposing your API to users, you may want to group API methods into namespaces to give your SDK an object-oriented interface. This type of interface can help users to better conceptualize the objects they are manipulating when they use the API.

Default Behavior

By default, Speakeasy will use the tags in your OpenAPI spec as the organizing principles for namespaces. For each tag in your spec, a namespace will be created.

Each method will be then be added to namespaces corresponding with its tags. If a method does not have an associated tag, then it will be added to the root sdk class of the generated client library. In the case where multiple tags are associated, the operation will appear as a method in multiple classes.

The example below shows one method added to a namespace, and another left to the default class:

The generated SDK will have methods invocable like so:

Define Namespaces Without Tags x-speakeasy-group

Sometimes the tags in an OpenAPI spec may already be used for an unrelated purpose (for example autogenerating documentation). In this scenario, you may want to use something other than tags to organize your methods.

For this scenario, we support a x-speakeasy-group field which allows you to define custom namespaces. This field can be added to any operation in your OpenAPI spec. If added, x-speakeasy-group overrides any tags associated to that particular method:

The generated SDK will have a method invocable like so:

Define Multi-Level Namespaces

You can use tags or the x-speakeasy-group extension to define nested namespaces for your operations using . notion. There is no limit to the number of levels you can define.

The generated SDK will have a method invocable like so:

Multiple Namespaces

If you want to add a method to multiple namespaces, simply list multiple values in tags or x-speakeasy-group. Both accept an array of values:

Your SDK would have methods invocable like so: