dotsasteriskdots/swagger-client

1.0.1 2016-09-24 10:02 UTC

This package is not auto-updated.

Last update: 2024-04-17 17:10:28 UTC


README

Hackathonの Web API 仕様書

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 0.9
  • Build date: 2016-09-24T07:36:11.528Z
  • Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com//.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

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

$api_instance = new Swagger\Client\Api\DefaultApi();
$object_id = "object_id_example"; // string | オブジェクトID
$object_value = new \Swagger\Client\Model\UserObjectValue(); // \Swagger\Client\Model\UserObjectValue | オブジェクト登録データ

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

?>

Documentation for API Endpoints

All URIs are relative to https://bcd-web.net/

Class Method HTTP request Description
DefaultApi addObjectValueUsingPOST POST /api/v1/user/objects/{objectId} オブジェクトの登録
DefaultApi createAssetsUsingPOST POST /api/v1/user/assets アセット作成
DefaultApi createNewAccountUsingPOST POST /api/v1/user/useradd ユーザーの作成
DefaultApi createObjectUsingPOST POST /api/v1/user/objects オブジェクトの作成
DefaultApi findAssetsUsingGET GET /api/v1/user/assets/find アセット検索
DefaultApi findCountObjectValuesUsingGET GET /api/v1/user/objects/{objectId}/findCount オブジェクトの登録データの検索結果件数
DefaultApi findObjectValuesUsingGET GET /api/v1/user/objects/{objectId}/find オブジェクトの登録データの検索
DefaultApi getObjectCountUsingGET GET /api/v1/user/objects/{objectId}/count オブジェクトの登録件数の参照
DefaultApi getObjectValueUsingGET GET /api/v1/user/objects/{objectId}/{index} オブジェクトの参照
DefaultApi getObjectValuesUsingGET GET /api/v1/user/objects/{objectId} オブジェクトの登録データの参照
DefaultApi queryAssetsBalanceUsingGET GET /api/v1/user/assets/{assetsName} アセットの残高照会
DefaultApi queryAssetsTradingHistoryUsingGET GET /api/v1/user/assets/{assetsName}/tradingHistory アセットの取引履歴参照
DefaultApi sendAssetsUsingPOST POST /api/v1/user/assets/{assetsName}/send アセットの送信

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author