Skip to main content

Getting started overview

The liblab WebApp is your central hub for managing SDKs, documentation, accounts, organizations, and team members.

Logging in​

To access the liblab WebApp:

  1. Navigate to liblab WebApp.
  2. Enter your credentials and click Continue. If you're new to liblab, click Sign up to create an account.
info

Every liblab account is part of an organization. To learn more about organizations and roles, access Sign up for a liblab account.

Welcome to liblab​

After logging in, you'll arrive at the Welcome Page, where you can start with one of two options:

  • Build SDKs directly from here: Easily generate SDKs by uploading your API spec using the WebApp.
  • Build SDKs using the CLI: Follow the guided steps to install and use the liblab CLI for SDK generation.

Choose your preferred option to continue with the onboarding.

liblab Welcome Page showing onboarding options

Creating your first SDK using the WebApp​

When you select Build SDKs directly from here, you'll be redirected to the New Build page. Here, you can upload your API spec (in JSON or YAML format) to generate SDKs.

New build page to upload your API spec

To generate your first SDK, follow the steps:

  1. Upload your API spec by dragging and dropping the file.
  2. Configure the SDKs to be generated:
    • SDK Languages: Choose the languages you want the SDK to support.
    • Authentication Type: Specify the API's authentication method.
note

The Prefix is optional only when using Access or Bearer tokens. For API Keys, you can optionally include a header field. Other authentication methods do not have optional fields.

Authentication options

Access the Authentication page to see all the authentication options available when creating an SDK.

  1. Click Generate SDKs.
  2. liblab will validate your API spec and highlight any issues affecting the SDK. If warnings or errors are found, they will be listed. If only warnings are identified, you can click Build SDKs and ignore warnings to proceed. However, if errors are detected, they must be resolved before continuing.
  3. Once complete, liblab lists the generated SDKs for download and testing. You can access your SDK build history by clicking Go to My Builds.

generated SDKs and download options

info

Access the Reference Guide for a full list of supported SDK languages.  

If you need more information on how to generate an SDK using your API spec, check the Quickstart Guide.

Managing your builds​

The My Builds page provides an overview of all your generated SDKs. To access it, from the sidebar, click My Builds. Here you can view details for each API, including:

  • API Version
  • Creator
  • Last Build Date and Time

You can also generate new SDKs by clicking New Build.

My builds pages where you can see the build history and create new SDKs

You can view the build history at My Builds by selecting an API. You’ll see detailed logs, including warnings or errors encountered during SDK generation. You can also download previously generated SDKs.

detailed build history for an API

info

For additional information on how to view and manage your SDKs, access the APIs documentation page.

Using the liblab CLI​

The liblab CLI provides flexible SDK generation options for users who prefer command-line tools.

When you select Build SDKs using the CLI, the Welcome Page guides you through installation with your preferred package manager:

CLI package manager options

After you select your preferred package manager, liblab will present the steps for installing and starting to use the CLI. In summary, to create your first SDK using the CLI, you have to execute the following steps:

  1. Install the liblab CLI using your chosen package manager.
  2. Log in to the CLI with your liblab account.
  3. Initialize the project running liblab init. Use the config.json file to define your API and SDK configuration.
  4. Build the SDK by running the liblab build command.

npm guide

info

For a detailed walkthrough, check the End-to-end SDK generation tutorial.

What's next?​

Now that you're familiar with the liblab WebApp and CLI, explore additional features:

Last updated on