crsytalpf/words

dev-master 2019-08-12 03:14 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• Swagger and contributors

• php
• api
• sdk
• swagger

README

The Words Bank of Crystal Platform. Crystal Bank have a huge collection and Words Bank is one of them. Words bank have so many words and more information about that word. Each words have one or more meaning from another language with a description. For now all words catogarzied as follow.

ID	CATOGARY
1	ICT

As the Bank is built with a NoSQL database, all information about a single Data is with that word, and all words may not have same information. And so many information is yet to come. Current data will retrive,

• Word in English
• Word in Sinhala
• Meaning in Sinhala
• Descrtipion in Sinhala
• Description in English
• ID

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

• API version: v0.0.0.1
• Package version: 0.0.1
• Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit https://dev.pmkg.lk/help

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // 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()
);

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

?>

Documentation for API Endpoints

All URIs are relative to https://k9aqkpifhj.execute-api.ap-southeast-1.amazonaws.com/default

Class	Method	HTTP request	Description
DefaultApi	wordsGet	GET /words	Get All Words available from Crystal Words Bank
DefaultApi	wordsOptions	OPTIONS /words
DefaultApi	wordsPost	POST /words	POST Request will update any data in the Bank

Documentation For Models

• ModelEmpty

Documentation For Authorization

All endpoints do not require authorization.

Author

[e-mail]