Getting Started with APIGit

APIGit is a powerful platform that combines native Git functionality with comprehensive API development tools to provide a seamless one-stop experience. For version control, you get the full power of Git with a familiar workflow similar to GitHub or GitLab. For API management, our intuitive, fully visualized editor lets you design and manage API specifications quickly and easily - no prior knowledge required. Built on the industry-standard OpenAPI specification, APIGit simplifies the entire API lifecycle from design and documentation to governance and mock servers.

1 · Sign Up & Log In

Creating Your Account

1. Navigate to app.apigit.com 
2. Click on Create an account to create a new account
3. Fill in your details and submit the form
4. Check your email inbox and verify your account
5. Return to the login page and sign in with your credentials

2 · Create a Repository

After logging in, you’ll be directed to the Repository list where you can see all your API repositories. To create a new one:

1. Click the Create Repository button at the top left of My Repositories. Under Collaborative Repositories, the button is Create Org Repository and creates a repository in one of your organizations
2. You’ll be presented with hosting options for your repository

Selecting Repository Hosting

APIGit offers flexible hosting options to suit your workflow:

• APIGit: Store your API Repository directly on our platform. This is the most efficient and recommended way since APIGit builds in native Git and provides a GitHub-similar experience, giving you one stop for both API Development and Git-based version control.
• Any Git Platform: Connect to GitHub, GitLab, Bitbucket, or any other type of Git Provider, with two-way synchronization. This option is available on the Enterprise plan.

Repository Setup

After selecting your hosting preference:

1. Choose whether to create a blank repository or migrate an existing one from another platform (Blank Repository or Migration)
2. If migrating, enter the repository URL and necessary credentials
3. Provide repository details (name and description)

4. Click Next to review your choices
5. Click Create API Repository to confirm

Once created, you’ll be redirected to your new repository’s page where you can start designing your APIs.

3 · Next Steps

After the repository is created, you can now enjoy all the features of APIGit. They will be introduced in the following sections:

• Native Git: Enjoy the full power of Git-based collaboration, including version control, branching, pull request, and review processes to manage your API specifications in your API repository.
• API Design: Create and edit API specifications using the most intuitive visual editor.
• API Documentation: Publish API documentation from any point of the Git history, or let it follow a branch, to create a beautiful document site and even host it on your domain.
• API Governance: Enforce API governance policies to ensure that your APIs are consistent and adhere to best practices and your organization’s standards.
• API Mocking: Publish a mock server from your OpenAPI documents with no code, or run your own Express.js scripts, and test your applications without needing a live server.