clever/clever

v1.0.1 2018-07-05 21:59 UTC

README

此仓库不再由Clever维护。我们提供的Swagger定义在 https://github.com/Clever/swagger-api

clever-php

Clever API

此PHP包是由Swagger Codegen项目自动生成的

  • API版本:2.0.0
  • 构建包:io.swagger.codegen.languages.PhpClientCodegen

要求

PHP 5.4.0及更高版本

API文档

查看更详细的文档 此处

安装与使用

Composer

要使用Composer安装绑定,请将以下内容添加到composer.json

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/clever/clever-php"
        }
    ],
    "require": {
       "clever/clever": "*"
}
}

然后运行composer install

注意,包括vcs链接是必要的,以确保您从本仓库拉取。

Composer的包管理器目前没有指向clever/clever-php的正确仓库。

我们发布为clever/clever

手动安装

下载文件并包含autoload.php

require_once('/path/to/clever-php/autoload.php');

测试

要运行单元测试

make test

入门指南

请遵循安装步骤,然后运行以下命令

<?php
require_once('./autoload.php');

$api_instance = new Clever\Api\DataApi();

// Note: This is hard coded for demo purposes only. Keep your access tokens secret!
// https://dev.clever.com/docs/security#section-security-best-practices
$api_instance->getConfig()->setAccessToken('TEST_TOKEN');

try {
    $result = $api_instance->getStudents();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getStudents: ', $e->getMessage(), PHP_EOL;
}

?>

更新库

  1. Git克隆swagger-codegen (https://github.com/swagger-api/swagger-codegen)

  2. Git克隆Clever的swagger-api仓库 (https://github.com/Clever/swagger-api)

  3. 在swagger-codegen仓库中运行此命令

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i $PATH_TO_SWAGGER_API_REPO/v2.0-client.yml -c $PATH_TO_THIS_REPO/override/config.json -l php -o $PATH_TO_THIS_REPO --additional-properties packageVersion=$VERSION
  1. 运行make override以复制覆盖文件

发布

  1. 更新CHANGELOG
  2. git tag -a vX.X.X
  3. git push --tags origin HEAD:master
  4. 登录Packagist (凭据在1PFT) 并点击“更新”