Show menu

Upload your first API definition

• Create your Bump.sh account
• Create your first documentation
  • Step 1: Create your organization
  • Step 2: Create your documentation
  • Step 3: Enjoy

Publishing your first API documentation on Bump.sh will only take you a few moments. Creating an account, documentation, and uploading your first API definition can be done in just a few clicks.

Create your Bump.sh account #

The very first step is to create your Bump.sh account.

Two options are available: using your email address, or through your GitHub account.

Create your first documentation #

Step 1: Create your organization #

Now that your Bump.sh account is created, you will immediately be prompted to create your first organization. An organization allows you to work alone or collaboratively on your API documentation and hubs (a collection of documentation) within the same workspace.

Step 2: Create your documentation #

Once the organization is created, you’re now ready to create your first documentation.

Then, all that’s left is to upload your first API definition. You can also use our CLI or use one of the provided examples to get started with Bump.sh.

Step 3: Enjoy #

And there you have it: you’ve just deployed your first API documentation!
You can already check out the result or start exploring the many options available to you for customization, inviting your team and API consumers, or creating new ones.