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 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, Speakeasy will create a namespace.

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

The following example illustrates the method sdk.Drinks.ListDrinks() assigned to the Drinks namespace and another method sdk.ListLocations() kept in the default class:

The generated SDK will include methods that can be invoked as follows:

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.

The x-speakeasy-group field allows you to define custom namespaces. Add this field to any operation in your OpenAPI spec to override any tags associated with that method. For example:

The generated SDK will include a method, which can be invoked as follows:

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 include a method, invoked as follows:

Multiple Namespaces

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

The generated SDK will include methods that can be invoked as follows: