Example API TypeScript SDK

This SDK is generated from the spec-repo-downstream-sdks example.

Overview

This repository demonstrates a downstream SDK that is automatically generated when changes are made to a central spec repository. The workflow:

1. A PR is created in the spec repo with OpenAPI spec changes
2. The spec repo workflow triggers this repo's generate-sdk-from-spec.yaml workflow
3. This workflow generates the SDK and creates a PR for review

Installation

npm install @speakeasy-sdks/example-api

Usage

import { ExampleAPI } from "@speakeasy-sdks/example-api";

const client = new ExampleAPI();

// List users
const users = await client.users.listUsers();

// Get a specific user
const user = await client.users.getUser({ id: "user-123" });

Related

• Spec repo example
• Python SDK

Summary

Example API: A simple example API to demonstrate spec repo SDK generation workflow

Table of Contents

• Example API TypeScript SDK
  • Overview
  • Installation
  • Usage
  • Related
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging

SDK Installation

Tip

To finish publishing your SDK to npm and others you must run your first generation action.

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add https://github.com/speakeasy-api/examples-downstream-spec-sdk-typescript

PNPM

pnpm add https://github.com/speakeasy-api/examples-downstream-spec-sdk-typescript

Bun

bun add https://github.com/speakeasy-api/examples-downstream-spec-sdk-typescript

Yarn

yarn add https://github.com/speakeasy-api/examples-downstream-spec-sdk-typescript

Note

This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import() to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { ExampleAPI } from "@speakeasy-sdks/example-api";

const exampleAPI = new ExampleAPI();

async function run() {
  const result = await exampleAPI.listUsers();

  console.log(result);
}

run();

Available Resources and Operations

Available methods

ExampleAPI SDK

• listUsers - List all users
• createUser - Create a user
• getUser - Get a user

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

• createUser - Create a user
• getUser - Get a user
• listUsers - List all users

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { ExampleAPI } from "@speakeasy-sdks/example-api";

const exampleAPI = new ExampleAPI();

async function run() {
  const result = await exampleAPI.listUsers({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { ExampleAPI } from "@speakeasy-sdks/example-api";

const exampleAPI = new ExampleAPI({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await exampleAPI.listUsers();

  console.log(result);
}

run();

Error Handling

ExampleAPIError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
error.message	string	Error message
error.statusCode	number	HTTP response status code eg 404
error.headers	Headers	HTTP response headers
error.body	string	HTTP body. Can be empty string if no body is returned.
error.rawResponse	Response	Raw HTTP response

Example

import { ExampleAPI } from "@speakeasy-sdks/example-api";
import * as errors from "@speakeasy-sdks/example-api/models/errors";

const exampleAPI = new ExampleAPI();

async function run() {
  try {
    const result = await exampleAPI.listUsers();

    console.log(result);
  } catch (error) {
    if (error instanceof errors.ExampleAPIError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

• ExampleAPIError: The base class for HTTP error responses.

Less common errors (6)

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from ExampleAPIError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { ExampleAPI } from "@speakeasy-sdks/example-api";

const exampleAPI = new ExampleAPI({
  serverURL: "https://api.example.com",
});

async function run() {
  const result = await exampleAPI.listUsers();

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { ExampleAPI } from "@speakeasy-sdks/example-api";
import { HTTPClient } from "@speakeasy-sdks/example-api/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new ExampleAPI({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { ExampleAPI } from "@speakeasy-sdks/example-api";

const sdk = new ExampleAPI({ debugLogger: console });