Quickstart

Connect your OpenAPI spec and ship your first SDK in under 10 minutes.

Step 1: Create an Apistaq project

Sign up at apistaq.com/login/signup. After confirming your email, you'll be prompted to create your first project. Give it a name that matches your API (e.g., payments-api).

Step 2: Connect your OpenAPI source

In your project settings, navigate to Source. Choose one of:

GitHub / GitLab / Bitbucket — Authorize the Apistaq app and select your repo + branch. Apistaq will sync on every push to that branch.
Direct URL — Provide a URL to your OpenAPI YAML or JSON file. Apistaq polls on a configurable interval.
Manual upload — Upload a .yaml or .json file. Useful for initial setup or testing.

Tip: Use the main or release branch as your source. Avoid pointing Apistaq at a develop or feature branch — SDK consumers expect stable releases, not work-in-progress.

Step 3: Configure your SDKs

Navigate to SDKs in your project. Enable the languages you want to ship:

sdk-config.yaml (example)

            sdks:
              typescript:
                package_name: @your-co/payments-sdk
                registry: npm
              python:
                package_name: your-co-payments
                registry: pypi
          

Step 4: Add your registry credentials

Go to Settings → Secrets. Add your npm token (for TypeScript/JavaScript) and PyPI API token (for Python). These are encrypted at rest and never exposed in logs.

Step 5: Trigger your first sync

Click Sync now in your project dashboard. Apistaq will:

Fetch your OpenAPI spec
Validate the spec (reports warnings, not errors, for minor issues)
Generate SDKs for your configured languages
Run type-checking and linting
Publish to your configured registries

The full pipeline takes 60–90 seconds for most specs. You'll receive an email notification when the first release is published.

Next steps: Read the SDK Guides to configure advanced options like custom templates, error handling, and retry policies.