API Maker

The backend engine for the AI era

Chapters

What you will learn

  • Connect a repository, and the first commit
  • A branch, a change compared and committed
  • A teammate, from a clone
  • Pull, with its live log
  • The history of one item
  • A deployment hook, called by the CI
In the docsGit integration
Transcript912 words · click a time to play from there

Intro

Everything you build in API Maker is text. In this video, the whole project goes into your own Git repository. You see branches, commits, a pull with its live log, the history of every item, and a deployment hook for your CI.

A backend in a panel, the usual way

A backend built in a web panel usually has problems. There is no history of who changed what. Settings are copied by hand from dev to production. Changes go live without a review. And a rollback depends on memory. With API Maker, every item of the account is a file in your own Git repository. Status, compare, and commit are in the panel. A branch is pulled on any server, by hand or by your CI.

And every item has its history, with a revert one click away. In this video: a repository connected, the first commit, a branch and a change, the work of a teammate, pulled, the history of one item, and a deployment hook for the CI.

Connect a repository

This is the Git page of Calm Home. There is no repository yet. Click Connect a repository. User info opens on its Git section. Give the Git URL with its credentials, blurred here. API Maker reads the host, the repository, and the user from it. Give the email of the commits. Click Update. The repository is connected, with its branches. main becomes the working branch. Commits go to it, and pulls come from it.

The first commit

Check status compares the account with the branch. Every file is added, because the repository holds only a README. When it is collapsed, you see the kinds: the custom API, the instances, the schemas, the group, the API user, and the project files of every language. Every change is ticked. The line above the message says what the commit carries. Untick a file, and it stays out. Write a message, click Commit to main, and confirm.

Nothing is left to commit. The account is in Git.

A branch and a change

Marketing wants free shipping from one hundred and twenty. Make a new branch, feature slash free shipping 120, from main. We work on it right away, so it is now the working branch. The change is saved in Cart Quote. Check status shows one file changed: the code of Cart Quote. Click Compare. The branch is on the left, the account is on the right, and one line changed: one hundred and fifty to one hundred and twenty.

Revert puts back a change you do not want. Close it. Write: Free shipping from 120, commit to the branch, and confirm.

A teammate, pulled

Meanwhile, Arjun works in a clone of the same repository, on the same branch. He changes the shipping fee of Cart Quote to seven point nine. He commits it, and pushes it. It is plain Git, from any editor. Back in the panel, click Pull, and confirm. The server clones the branch, and writes every item in one transaction, step by step, with a live log. The branch is live in the account, with the fee of Arjun.

And the branch is marked as last pulled. On a QA or a production server, the same Pull brings a branch in.

The history of one item

Every item keeps its history. Open Cart Quote in API Testing. The Git icon opens its history. You see the version live in the database, then every commit that changed Cart Quote. Shipping fee 7.9, by Arjun Mehta, and the line it changed. Free shipping from 120, by Nisha. The lower fee was for a sale that is over. So click Revert, to the version before it, and confirm. Only the database changed.

The current version says uncommitted, until it is reviewed and committed.

A deployment hook

A pipeline can pull too. Make a new deployment hook. It is an address of this server, which pulls a branch. Name it ci_main. The access token and the secret are random, and blurred here. Once saved, the secret cannot be read again. Allowed IP lists the addresses of your CI. If it is empty, any caller with the token and the secret gets an answer. Save it. After a merge into main, the pipeline calls the hook.

It sends a GET, with the token and the secret from its own secrets, and the branch. The answer says: pulled, with no migration error. In the panel, main is the branch last pulled, a few seconds ago, by the hook.

Good to know

Good to know. Secrets never go into the Git repository. Each server keeps its own, so the same code reaches the database of that server. After a pull, the migration scripts that never ran on that server are listed to run. A deployment hook runs them by itself. Auto increments belong to one environment. Commit them only on the branches dev, qa, uat, or prod. Pull without secret is for a repository made on another installation.

Built on standards

It is plain Git: GitHub, GitLab, Bitbucket, Azure DevOps, or your own server. The panel opens a pull request on the first four. Every account has the same layout, one folder for each kind and each item, so a diff reads like the panel. And a server runs exactly what was reviewed and merged.

Recap

To sum up. Connect a repository in User info. Check status, compare, and commit. Use branches, and pull with a live log. Every item has its history, and a revert is one click away. And a deployment hook serves your CI. Next: developer accounts, a workspace for every developer. API Maker. Build faster, spend smarter, deliver better.