storehouse / sdk-php
Storehouse API SDK for PHP
dev-master
2020-05-02 03:18 UTC
Requires
- php: >=7.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- phpunit/phpunit: ^7.4
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2024-09-29 05:42:37 UTC
README
Storehouse (sthse.co) API
此PHP包由OpenAPI Generator项目自动生成
- API版本:0.1
- 构建包:org.openapitools.codegen.languages.PhpClientCodegen
需求
PHP 5.5及更高版本
安装与使用
Composer
要通过Composer安装绑定,请将以下内容添加到composer.json
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
}
],
"require": {
"GIT_USER_ID/GIT_REPO_ID": "*@dev"
}
}
然后运行composer install
手动安装
下载文件并包含autoload.php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
测试
要运行单元测试
composer install
./vendor/bin/phpunit
入门指南
请按照安装过程进行操作,然后运行以下命令
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: apiAuthentication
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure HTTP basic authorization: basicAuthentication
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new OpenAPI\Client\Api\ProjectApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$name = 'name_example'; // string | Name of the project. The user's name is prefixed to the provided value.
$type = 'type_example'; // string | Type of the project (git, svn, or hg)
$public = True; // bool | If the project should be marked as public.
try {
$apiInstance->createProject($name, $type, $public);
} catch (Exception $e) {
echo 'Exception when calling ProjectApi->createProject: ', $e->getMessage(), PHP_EOL;
}
?>
API端点文档
所有URI都是相对于https://api.sthse.co
类 | 方法 | HTTP请求 | 描述 |
---|---|---|---|
ProjectApi | createProject | POST /v1/projects | 创建一个项目 |
ProjectApi | deleteProject | DELETE /v1/projects/{name} | 删除一个项目 |
ProjectApi | disableModule | POST /v1/projects/{name}/modules/{module}/disable | 禁用一个项目的模块 |
ProjectApi | enableModule | POST /v1/projects/{name}/modules/{module}/enable | 启用一个项目的模块 |
ProjectApi | getMyProjects | GET /v1/users/me/projects | 获取用户可见的项目 |
ProjectApi | getProject | GET /v1/projects/{name} | 获取一个项目 |
ProjectApi | patchProject | PATCH /v1/projects/{name} | 更新一个项目 |
ProjectApi | updateModule | PATCH /v1/projects/{name}/modules/{module}/settings | 更新一个项目的模块 |
UserApi | getMe | GET /v1/users/me | 列出当前用户 |
UserApi | getMyProjects | GET /v1/users/me/projects | 获取用户可见的项目 |
UserApi | patchMe | PATCH /v1/users/me | 更新当前用户 |
模型文档
授权文档
apiAuthentication
- 类型:HTTP基本认证
basicAuthentication
- 类型:HTTP基本认证