README

这是 Microgen API 的官方 PHP 客户端。

Microgen 是一个无需代码的后端 API 平台或后端即服务（BaaS），让您能够以最快的速度创建后端 API。我们让开发者能够无需接触后端代码即可轻松构建后端 API。

访问 Microgen 获取更多信息，并查看 我们的文档 以获取更多技术细节。

API 文档

有关 API 文档，请访问 Microgen API 参考。

安装

要安装 SDK，您可以使用 Composer 或直接下载源代码并将其解压到您的目录。如果您使用 Composer，请运行以下命令

composer require microgen-v3/sdk

用法

在开始之前，您需要在 Microgen 控制台 上注册以获取您项目的 API 密钥。

创建客户端

<?php

use Microgen\MicrogenClient;

$microgen = new MicrogenClient([
	'apiKey': 'YOUR_API_KEY' // Your API Key from app.microgen.id
]);

身份验证

注册

$res = $microgen->auth->register([
	'firstName' => 'Ega',
	'lastName' => 'Radiegtya',
	'email' => 'user@mail.com',
	'password' => 'password'
]);

echo $res['user']; // The data of registered user
echo $res['token']; // The token of registered user

登录

$res = $microgen->auth->login([
	'email' => 'user@mail.com',
	'password' => 'password'
]);

echo $res['user']; // The data of logged-in user
echo $res['token']; // The token of logged-in user

获取用户信息

$res = $microgen->auth->user();

echo $res['user'];

更新用户信息

$res = $microgen->auth->update([
	'firstName' => 'Ega'
]);

echo $res['user'];

登出

$res = $microgen->auth->logout();

数据库

创建新记录

$res = $microgen->service('posts')->create([
	'name' => 'Post 1',
	'notes' => 'Hello Microgen'
]);

echo $res['data'] // The data of the new record

通过 ID 获取记录

$res = $microgen->service('posts')->getById('605a251d7b8678bf6811k3b1');

echo $res['data'] // The data of the record

查找记录

获取所有记录

$res = $microgen->service('posts')->find();

echo $res['data'] // The data of all records

查找记录并修改结果

// limit
$res = $microgen->service('posts')->find([
	'limit' => 10
]);

// sort
// ascending: 1
// descending: -1
$res = $microgen->service('posts')->find([
	'sort' => ['name' => 1]
]);

// skip
$res = $microgen->service('posts')->find([
	'skip' => 10
]);

// select
$res = $microgen->service('posts')->find([
	'select' => ['name', 'notes']
]);

// lookup all fields
$res = $microgen->service('posts')->find([
	'lookup' => '*'
]);

// lookup spesific fields
$res = $microgen->service('posts')->find([
	'lookup' => ['categories']
]);

// lookup but only show ids
$res = $microgen->service('posts')->find([
	'lookup' => ['_id' => '*']
]);

根据标准查找记录

// equals
$res = $microgen->service('posts')->find([
	'where' => [
		'name' => 'Ega'
	]
]);

// does not equal
$res = $microgen->service('posts')->find([
	'where' => [
		'name' => ['$ne' => 'Ega']
	]
]);

// contains
$res = $microgen->service('posts')->find([
	'where' => [
		'notes' => ['$contains' => 'hello']
	]
]);

// does not contain
$res = $microgen->service('posts')->find([
	'where' => [
		'notes' => ['$notContains' => 'hello']
	]
]);

// matches any of
$res = $microgen->service('posts')->find([
	'where' => [
		'name' => ['$in' => ['Ega', 'Radiegtya']]
	]
]);

// does not match any of
$res = $microgen->service('posts')->find([
	'where' => [
		'name' => ['$nin' => ['Ega', 'Radiegtya']]
	]
]);

// less than
$res = $microgen->service('posts')->find([
	'where' => [
		'total' => ['$lt' => 10]
	]
]);

// less than or equals
$res = $microgen->service('posts')->find([
	'where' => [
		'total' => ['$lte' => 10]
	]
]);

// more than
$res = $microgen->service('posts')->find([
	'where' => [
		'total' => ['$gt' => 10]
	]
]);

// more than or equals
$res = $microgen->service('posts')->find([
	'where' => [
		'total' => ['$gte' => 10]
	]
]);

更新记录

$res = $microgen->service('posts')->updateById('605a251d7b8678bf6811k3b1', [
	'notes' => 'Hello world'
]);

删除记录

$res = $microgen->service('posts')->deleteById('605a251d7b8678bf6811k3b1');

将记录链接以创建关系

$res = $microgen->service('posts')->link('605a251d7b8678bf6811k3b1', [
	'categories' => '61d26e8e2adb12b85c33029c'
]);

从关系中解除记录的链接

$res = $microgen->service('posts')->unlink('605a251d7b8678bf6811k3b1', [
	'categories' => '61d26e8e2adb12b85c33029c'
]);

计算总记录数

计算所有记录数

$res = $microgen->service('posts')->count();

计算符合给定标准的记录数

$res = $microgen->service('posts')->find([
	'where' => [
		'name' => 'Ega'
	]
]);

存储

上传文件

$file = fopen('/path/to/file', 'r');
$res = $microgen->storage->upload($file);

echo $res['data'] // The data of the uploaded file

反馈

请使用我们的GitHub 问题进行高级反馈。您还可以加入我们的Discord 服务器。