How do I avoid consuming the response body in an AfterSuccess hook?

To avoid exhausting the response stream, you should always call response.clone() before reading the body, allowing the original stream to continue to the caller.

Where are the hooks registered in the SDK structure?

Hooks are typically registered in the src/hooks/registration.ts file (or the equivalent path for your specific language), which acts as the entry point for custom logic.

Which programming languages are supported for these SDK hooks?

This skill supports all major languages generated by Speakeasy, including TypeScript, Go, Python, Java, C#, Ruby, and PHP.

Does this skill overwrite my custom hooks when I regenerate the SDK?

No, custom hook files and the registration logic in registration.ts are specifically designed to be preserved and protected during the SDK regeneration process.

Can I use hooks to implement HMAC signing for my API?

Yes, HMAC signing is a primary use case. You can use the BeforeRequest hook to sign the request object with a secret before it is dispatched.

SDK Hook Customizer

Name: SDK Hook Customizer
Author: speakeasy-api

byspeakeasy-api

•

API開発

Implements custom code logic and lifecycle hooks for Speakeasy-generated SDKs to handle telemetry, authentication, and request transformations.

The SDK Hook Customizer allows developers to inject custom business logic directly into the request-response lifecycle of Speakeasy-generated SDKs. By providing access to lifecycle events such as BeforeRequest and AfterSuccess, it enables the implementation of advanced features like HMAC signing, custom telemetry, and response transformations without losing changes during SDK regeneration. This skill ensures that your custom code is properly registered and maintained across updates, making it essential for building robust, production-grade API clients that require logic beyond standard OpenAPI specifications.

主な機能

015 GitHub stars

02Secure HMAC signature and custom authentication logic injection

03Safe persistence of custom logic files across SDK regenerations

04Lifecycle hook implementation for BeforeRequest, AfterSuccess, and AfterError events

05Automated telemetry, logging, and observability integration

06Request and response transformation middleware support

ユースケース

01Adding HMAC signing or custom security headers to every outgoing API request

02Implementing SDK-level observability by sending request metrics to telemetry providers

03Normalizing complex API error responses into standardized application-specific exceptions

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add speakeasy-api/skills customize-sdk-hooks

For use in Claude.ai and ChatGPT

Download Skill