gitee-php / gitee-enterprise-sdk
gitee 企业 SDK for PHP
v1.1.0
2024-08-07 01:46 UTC
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2
README
Gitee Enterprise SDK for PHP (由 Swagger Codegen 生成 https://github.com/swagger-api/swagger-codegen)
要求
PHP 5.5 及更高版本
安装 & 使用
Composer
composer require gitee-php/gitee-enterprise-sdk
手动安装
下载文件并包含 autoload.php
require_once '/path/to/vendor/autoload.php';
入门
请遵循安装过程,然后运行以下命令
<?php require_once __DIR__ . '/vendor/autoload.php'; $apiInstance = new GiteeEnterprise\Api\AdminLogsStatisticApi( // 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() ); $enterpriseId = 56; // int | 企业id (https://gitee.com/api/v8/swagger#/getList 的返回值的 id) $accessToken = "accessToken_example"; // string | 用户授权码 $member = "member_example"; // string | 成员username $startDate = "startDate_example"; // string | 查询的起始时间。(格式:yyyy-mm-dd) $endDate = "endDate_example"; // string | 查询的结束时间。(格式:yyyy-mm-dd) $page = 1; // int | 当前的页码 $perPage = 56; // int | 每页的数量,最大为 100 try { $result = $apiInstance->getEnterpriseIdLogStatisticsDeployKeyLogs($enterpriseId, $accessToken, $member, $startDate, $endDate, $page, $perPage); print_r($result); } catch (Exception $e) { echo 'Exception when calling AdminLogsStatisticApi->getEnterpriseIdLogStatisticsDeployKeyLogs: ', $e->getMessage(), PHP_EOL; } ?>
警告
由于 Gitee 官方提供的 swagger.json
存在错误,因此本 SDK
中存在部分 API
的返回值 Model
未能正确返回内容,如果发现可以提交 问题 或提交 Pull Request
。
同时为了减小影响,可以使用 SDK
提供的 ResponseHandler
来获取到原始响应。
<?php require_once __DIR__ . '/vendor/autoload.php'; $response = new GiteeEnterprise\ResponseHandler(); $client = $response->createClientWithMiddleware(); $apiInstance = new GiteeEnterprise\Api\MembersApi($client); $enterpriseId = 56; // int | 企业id (https://gitee.com/api/v8/swagger#/getList 的返回值的 id) $accessToken = "accessToken_example"; // string | 用户授权码 try { $result = $apiInstance->getEnterpriseIdMembers($enterpriseId, $accessToken); print_r($result); print_r($response->toArray()); } catch (Exception $e) { echo 'Exception when calling MembersApi->getEnterpriseIdMembers: ', $e->getMessage(), PHP_EOL; } ?>
API 端点文档
所有 URI 都是相对于 https://api.gitee.com/enterprises
模型文档
- 注解
- 注解
- 附件文件
- 附件文件问题
- 分支
- 带有键的批量响应
- 检查运行
- 检查运行输出
- 检查运行摘要
- 检查运行列表
- 选择分支
- 提交
- 提交基础
- 提交分支
- 提交比较
- 提交详情
- 提交列表
- 提交笔记
- 提交笔记详情
- 提交签名
- 部署密钥
- 部署密钥日志
- 差异
- 差异位置
- 文档
- 文档附件文件
- 文档目录
- 文档节点
- 文档节点详情
- 文档节点级别
- 文档节点日志
- 文档最近
- 电子邮件邀请
- 企业
- 企业认证
- 企业部署密钥
- 企业导航
- 企业计划
- 企业计划列表
- 企业项目
- 企业项目列表
- 企业配额
- 企业角色
- 企业角色基础
- 企业角色详情
- 企业角色日志
- 企业 Scrum 版本
- 环境变量
- 事件
- 文件版本
- giteego 管道
- 组
- 组详情
- 组管理日志
- 组成员
- 带认证的组
- 邀请组成员
- 邀请项目组成员
- 问题
- 问题认证
- 问题详情
- 带相关信息的问题详情
- 问题字段
- 问题甘特图
- 问题主
- 问题成员选择
- 问题笔记
- 问题操作日志
- 问题反应
- 问题状态
- 问题状态详情
- 问题迁移状态
- 问题类型
- 企业问题类型
- 计划问题类型
- 问题类型状态引用
- 带状态引用的问题类型
- 问题工作量概述
- 标签
- 标签详情
- 链接问题
- 成员
- 成员申请
- 成员批量修改
- 成员管理日志
- 成员周报
- 里程碑
- 里程碑详情
- 里程碑列表
- 模型命名空间
- 我的周报
- 操作系统项目
- 操作系统项目列表
- PR 分配
- PR 分配者
- PR 操作日志
- 计划
- 计划组件
- 计划目录
- 计划额外字段
- 计划列表
- 计划管理日志
- 带认证的计划
- 带收集的计划
- 带组件的计划
- 项目
- 项目访问日志
- 项目基础
- 项目基础设置
- 项目克隆方式基础
- 项目贡献者
- 项目详情
- 项目组
- 项目组详情
- 项目组管理日志
- 项目组成员
- 项目组操作权限
- 项目组根
- 项目管理日志
- 项目成员
- 项目成员添加
- 项目成员列表
- 项目成员概述
- 项目概述
- 项目推送配置
- 项目角色
- 项目摘要
- 项目同步设置
- 项目标签基础
- 带权限的项目
- 项目列表
- 拉取请求
- 拉取请求权限
- 拉取请求详情
- 拉取请求文件
- 拉取请求备注
- 拉取请求备注树
- 拉取运行
- 反应
- 发布
- 结果响应
- 撤销的拉取请求
- 根组成员
- 敏捷文档节点
- 敏捷冲刺
- 敏捷阶段
- 安全设置日志
- 统计
- 标签
- 测试计划
- 测试仓库
- 树状备注
- 用户
- 用户项目列表
- 用户统计
- 带备注的用户
- 用户工作量列表
- 用户项目
- 周报
- 周报详情
- 周报备注
- 周报预览
- 周报关系
- 周报模板
- 维基信息
- 维基排序
- 维基排序详情
- 带附件文件
- 带工作量