Sample Build with SDK Source Tree

This repository is a sample project that demonstrates how to publish a TypeScript SDK to a git repository using the APIMatic CLI. It serves as a source of truth for API specifications and publishes the generated SDK to the apimatic/sample-customized-typescript-sdk repository.

Overview

Project Structure

• src/ - Source code organization:
  • sdk-source-tree/ - SDK customizations
  • spec/ - Specification configuration
• .github/workflows/
  • sdk-publish.yaml - SDK publish workflow

Workflow

The Sdk Publish workflow publishes TypeScript SDK to a git repository using the APIMatic CLI. It is triggered manually from GitHub Actions with a version input.

Required Secrets

The following secrets have been configured in the repository settings to enable the workflow:

1. API_KEY (Required)

• Type: APIMatic API Key
• Purpose: Authenticates with the APIMatic CLI to access SDK publish services
• Setup: Obtain from your APIMatic account dashboard

Customizations

The following customizations have been applied to the generated SDK in the apimatic/sample-customized-typescript-sdk repository:

1. Add a new GitHub workflow to save customizations: Adds a GitHub Actions workflow to save SDK customizations across regenerations.
2. Add unit tests for API calls: Adds unit tests to validate the behavior of API calls in the SDK.
3. Add a new flow to chain API calls: Introduces a reusable flow that chains multiple API calls.
4. Implement custom authentication: Implements a custom authentication mechanism to support non-standard auth schemes.
5. Add custom signature verifier to webhook manager: Adds a custom signature verifier to the webhook manager for enhanced security.
6. Add API lifecycle hooks: Introduces lifecycle hooks to intercept and customize API request and response handling.