Skip to main content

SDK Publishing Overview

The next step after generating SDKs is distributing them to Developers. The most convenient method for developers to consume third-party libraries in their applications is via Package Managers like npm or pip. This is why it’s important to make your SDKs available on popular Package Managers.

To ensure your library can be easily accessed through a Package Manager, you'll need to publish it to a Package Registry or Repository. These registries act as centralized databases that Package Managers rely on to locate and retrieve libraries. For instance, if you're using npm as your Package Manager, your library needs to be published to the npm registry.

Publishing a package to a Package Registry usually involves building the source code and using a Command Line tool to push it to a Package Registry. This requires knowledge of the build process for the desired language as well as knowledge of the publishing process for the relevant Package Registry. If you are maintaining SDKs in multiple programming languages, this can become a challenge.

APIMatic makes the process of publishing SDKs trivial by providing an interface that takes care of generating, building, and publishing SDKs so you don't need any platform specific knowledge to distribute your SDKs. APIMatic also publishes your SDKs to GitHub so developers can track code changes and communicate issues to you.

How Publishing Works​

Whether you're shipping packages to a Package Registry or pushing source code to GitHub, publishing an SDK with APIMatic takes the same two steps:

  1. Set it up once in the Publishing Center. Create a publishing profile that holds your package and source code metadata, and add the credentials APIMatic needs for each package registry and for GitHub. See Setup Publishing Profiles.
  2. Publish from the CLI. Once the profile exists, run apimatic sdk publish from your terminal or CI/CD pipeline every time you want to ship a version. See Publish Via CLI.

The Publishing Center in the dashboard is where you manage publishing profiles, manage credentials, and monitor publishing logs. The publishing runs themselves are triggered through the CLI, which makes them straightforward to automate in a CI/CD pipeline.

The setup process is trivial and can be completed in 15 minutes for all programming languages supported by APIMatic.

Looking for the old dashboard flow?

The previous, fully UI-driven walkthroughs are preserved at SDK Publishing Tutorial (Legacy Dashboard) for package publishing and Publishing SDKs to GitHub (Legacy Dashboard) for source code publishing.

Supported Package Registries​

The following Package Registries are currently supported:

  • npm
  • Packagist
  • RubyGems
  • PyPI
  • NuGet
  • Maven Central