Dawn-Api

composer require liushoukun/dawn-api

composer create-project topthink/think api --prefer-dist
composer require liushoukun/dawn-api

cd /public/static/
git clone https://git.oschina.net/liushoukun/hadmin.git
```## Использование
1. Создайте модуль demo
2. Создайте базовый бизнес-класс Base, расширяющий ApiController
```php
<?php
namespace app\demo\controller;
use DawnApi\facade\ApiController;
class Base extends ApiController
{
    // Включение аутентификации прав доступа
    public $apiAuth = true;
}
?>

class User extends Base

Route::group('v1', function() {
    Route::resource('user', 'demo/User');
});

protected $extraActionList = ['sendCode'];   // Дополнительные действия

Route::group('v1', function () {
    Route::any('user/sendCode', 'demo/User@sendCode'); // Нужно зарегистрировать до ресурсного маршрута
    Route::resource('user', 'demo/User');
});

protected $skipAuthActionList = ['sendCode']; // Методы, пропускающие аутентификацию

### 1. Настройка конфигурации общего ключа аутентификации

```php
'api_auth' => true,  // Включить аутентификацию

/**
 * Аутентификация клиента с использованием данных запроса и маршрутов
 * В случае успеха возвращается true
 *
 * @param Request $request
 * @return bool
 */
public function authenticate(Request $request)
{
    // TODO: Реализовать метод authenticate()
    return true;
}

/**
 * Получение информации о пользователе
 * Можно использовать внутри API контроллеров
 *
 * @return mixed
 */
public function getUser()
{
    return ['app_id' => '111', 'name' => 'dawn-api'];
}

public $apiAuth = true; // Включить аутентификацию

'auth_class' => \app\demo\auth\BasicAuth::class, // Класс аутентификации
```/v1/user?client_id=test&secret=test  
или  
/v1/user с заголовками Basic- OAuth Клиентские учетные данные (Client Credentials)
  1. Конфигурация класса аутентификации
```php
    'auth_class' => \app\demo\auth\OauthAuth::class, // класс авторизации

namespace app\demo\controller;
use app\demo\auth\OauthAuth;
use think\Request;

class Auth {
    public function accessToken() {
        $request = Request::instance();
        $oauthAuth = new OauthAuth();
        return $oauthAuth->accessToken($request);
    }
}

Route::any('accessToken', 'demo/auth/accessToken'); // OAuth

// Документация
\DawnApi\route\DawnRoute::wiki();

return [
    '1' => ['name' => 'Тестовый документ', 'id' => '1', 'parent' => '0', 'class' => '', 'readme' => ''], // Нижележащие списки являются первым уровнем каталога
    '2' => ['name' => 'Получение прав', 'id' => '2', 'parent' => '1', 'class' => '', 'readme' => '/doc/md/auth.md'], // Документация без интерфейсов, загружается как markdown документ
    '3' => ['name' => 'Интерфейсы пользователя', 'id' => '3', 'parent' => '1', 'readme' => '', 'class' => \app\test\controller\User::class], // Документация интерфейса User
];

/**
```markdown
 * Класс User
  * @title Интерфейс пользователя
  * @url /v1/user
  * @desc Все интерфейсы, связанные с пользователем
  * @version 1.0
  * @readme /doc/md/user.md
  */
class User extends Base {}

    /**
     * @title Получение информации о пользователе
     * @desc Получение информации о пользователе
     * @readme /doc/md/method.md
     */
   public function getResponse(\think\Request $request){}

    /**
     * Правила параметров
     * @name Название поля
     * @type Тип данных
     * @require Обязательность
     * @default Значение по умолчанию
     * @desc Описание
     * @range Диапазон значений
     * @return array
     */
    public static function getRules()
    {
        $rules = [
            'index' => [],
            'create' => [
                'name' => ['name' => 'name', 'type' => 'string', 'require' => 'true', 'default' => '', 'desc' => 'Имя', 'range' => ''],
                'age' => ['name' => 'age', 'type' => 'integer', 'require' => 'true', 'default' => '0', 'desc' => 'Возраст', 'range' => '']
            ],
            'sendCode' => [
                'name' => ['name' => 'name', 'type' => 'string', 'require' => 'true', 'default' => '', 'desc' => 'Имя', 'range' => ''],
                'age' => ['name' => 'age', 'type' => 'integer', 'require' => 'true', 'default' => '0', 'desc' => 'Возраст', 'range' => '']
            ]
        ];
        // Можно объединять общие параметры
        return $rules;
    }

    * @return int id Уникальный идентификатор
    * @return string username Имя пользователя
    * @return int age Возраст
```|Параметр|Обязательный|Комментарий|
|:---:|:---:|:---:|
|Первый параметр|true|Тип||Второй параметр|true|Имя параметра|
|Третий параметр|true|Описание параметра|
>Правила заполнения типа  
```php
'string'    => 'строка',
'int'       => 'целое число',
'float'     => 'число с плавающей точкой',
'boolean'   => 'булево значение',
'date'      => 'дата',
'array'     => 'массив',
'fixed'     => 'фиксированное значение',
'enum'      => 'перечисление',
'object'    => 'объект',