113 lines
2.7 KiB
Markdown
113 lines
2.7 KiB
Markdown
|
# SwaggerClient-php
|
||
|
|
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
||
|
|
|
||
|
|
This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
||
|
|
|
||
|
|
- API version:
|
||
|
|
- Build package: io.swagger.codegen.languages.PhpClientCodegen
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
PHP 5.5 and later
|
||
|
|
|
||
|
|
## Installation & Usage
|
||
|
|
### Composer
|
||
|
|
|
||
|
|
To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:
|
||
|
|
|
||
|
|
```
|
||
|
|
{
|
||
|
|
"repositories": [
|
||
|
|
{
|
||
|
|
"type": "git",
|
||
|
|
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"require": {
|
||
|
|
"GIT_USER_ID/GIT_REPO_ID": "*@dev"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
Then run `composer install`
|
||
|
|
|
||
|
|
### Manual Installation
|
||
|
|
|
||
|
|
Download the files and include `autoload.php`:
|
||
|
|
|
||
|
|
```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](#installation--usage) and then run the following:
|
||
|
|
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
require_once(__DIR__ . '/vendor/autoload.php');
|
||
|
|
|
||
|
|
$apiInstance = new Swagger\Client\Api\GreetApi(
|
||
|
|
// 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->ping();
|
||
|
|
print_r($result);
|
||
|
|
} catch (Exception $e) {
|
||
|
|
echo 'Exception when calling GreetApi->ping: ', $e->getMessage(), PHP_EOL;
|
||
|
|
}
|
||
|
|
|
||
|
|
?>
|
||
|
|
```
|
||
|
|
|
||
|
|
## Documentation for API Endpoints
|
||
|
|
|
||
|
|
All URIs are relative to *http://localhost*
|
||
|
|
|
||
|
|
Class | Method | HTTP request | Description
|
||
|
|
------------ | ------------- | ------------- | -------------
|
||
|
|
*GreetApi* | [**ping**](docs/Api/GreetApi.md#ping) | **GET** /user/ping |
|
||
|
|
*UserApiApi* | [**getUserInfo**](docs/Api/UserApiApi.md#getuserinfo) | **GET** /api/user/{id} | 获取用户信息
|
||
|
|
*UserApiApi* | [**login**](docs/Api/UserApiApi.md#login) | **POST** /api/user/login | 登录
|
||
|
|
*UserApiApi* | [**register**](docs/Api/UserApiApi.md#register) | **POST** /api/user/register | 注册
|
||
|
|
*UserApiApi* | [**searchUser**](docs/Api/UserApiApi.md#searchuser) | **GET** /api/user/search | 用户搜索
|
||
|
|
|
||
|
|
|
||
|
|
## Documentation For Models
|
||
|
|
|
||
|
|
- [LoginReq](docs/Model/LoginReq.md)
|
||
|
|
- [RegisterReq](docs/Model/RegisterReq.md)
|
||
|
|
- [UserInfoReply](docs/Model/UserInfoReply.md)
|
||
|
|
- [UserInfoReq](docs/Model/UserInfoReq.md)
|
||
|
|
- [UserSearchReply](docs/Model/UserSearchReply.md)
|
||
|
|
- [UserSearchReq](docs/Model/UserSearchReq.md)
|
||
|
|
|
||
|
|
|
||
|
|
## Documentation For Authorization
|
||
|
|
|
||
|
|
|
||
|
|
## apiKey
|
||
|
|
|
||
|
|
- **Type**: API key
|
||
|
|
- **API key parameter name**: Authorization
|
||
|
|
- **Location**: HTTP header
|
||
|
|
|
||
|
|
|
||
|
|
## Author
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|