TRR

TRR

Введение

Что такое TRR?

TRR — это аббревиатура от ThinkPHP51 Reflection Restful API, которая обозначает стиль проектирования API. Из названия можно понять, что этот набор интерфейсов разработан на основе концепции отражения для создания Restful API.

Возможности TRR

1. Вы можете сначала узнать о том, что может делать ThinkPHP5.1.
2. ThinkPHP5.1 может делать всё то же самое, но в области маршрутизации на основе отражения мы уделяем больше внимания.

Мы фокусируемся на следующих аспектах:

• разработка Restful API с использованием отражения;
• генерация документации по API на основе отражения;
• быстрая проверка параметров в API на основе отражения;
• упрощение разработки и обслуживания API;
• облегчение процесса обновления API.

Наша цель — сделать разработку PHP-приложений более простой, быстрой и удобной. Мы хотим, чтобы разработчики могли сосредоточиться на бизнес-логике, а не тратить время на рутинные задачи, такие как создание маршрутов, написание документации и т. д.

Мы стремимся к тому, чтобы наши проекты были более быстрыми, стабильными и удобными в обслуживании.

Документация по использованию

Примечание: ветка master относится к версии TRR-v0.0.2.

Документация по версии TRR-v0.0.1: 👉 здесь.

Документация по версии TRR-v0.0.2: 👉 здесь.

Продолжение следует...

Быстрый старт

В папке проекта нажмите правой кнопкой мыши и выберите «Открыть Git Bash Here».

Затем в командной строке Git Bash выполните следующие команды:

1. Проверка серверной среды

• Установите PHP (версия 7.1 или выше).
• Установите Git (версия 1.8 или выше).
• Установите Composer (версия 1.8 или выше).

2. Получение исходного кода проекта

Получите исходный код проекта:

git clone https://github.com/china-wangyu/TRR.git

Перейдите в папку проекта:

cd TRR

3. Установка зависимостей проекта

Установите зависимости:

composer install

4. Запуск проекта

Чтобы избежать проблем с различными средами PHP и интегрированными и неинтегрированными программными решениями, рекомендуется использовать встроенный сервер ThinkPHP5.1 во время разработки. Дополнительная информация доступна здесь: https://www.kancloud.cn/manual/thinkphp5_1/518750.

Запустите проект:

wy@Mac TRR (master) $ php think run -H 127.0.0.1 -p 8000
ThinkPHP Development server is started On <http://127.0.0.1:8000/>
You can exit with `CTRL-C`
Document root is: /Users/wy/Desktop/TRR/public
[Mon Jul 29 16:39:08 2019] Failed to listen on 127.0.0.1:8000 (reason: Address already in use)

Эффект будет следующим: сервер запущен успешно.

5. Доступ через браузер

Теперь вы можете перейти в браузере по адресу:

http://127.0.0.1:8000/

Другие функции

Создание JWT-токена

Маршрут: http://127.0.0.1:8000/auth?name=trr&password=trr

Метод: POST

Ответ:

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJUUlIiLCJpYXQiOjE1NjI0MDk2MDgsImV4cCI6MTU2MjQxNjgwOCwidXVpZCI6MTAwLCJzaWduYXR1cmUiOiJ0cnIifQ.MXXGcK2xjAznzcC-PQ66dRAo30Wn1poNLCNbFcO7ORA",
    "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJUUlIiLCJpYXQiOjE1NjI0MDk2MDgsInV1aWQiOjEwMCwic2lnbmF0dXJlIjoidHJyIn0.RBs5iOSTjC89Z6H4CPl9tNyXHOhtmuPQPd7JOB_n5JY"
}

Обновление JWT-токена

Маршрут: http://127.0.0.1:8000/auth/refresh

Метод: GET

Заголовок: необходимо установить авторизацию.

Ответ:

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJUUlIiLCJpYXQiOjE1NjI0MTE0OTMsImV4cCI6MTU2MjQxODY5MywidXVpZCI6MTAwLCJzaWduYXR1cmUiOiJ0cnIifQ.4siwrzghm-r_SZNz-SUwkI3Of-9Hx9vOHMYdHXjf7rA"
}

Генерация markdown-документации по API

• Командная строка:

Откройте командную строку или терминал в корне проекта и введите следующую команду:

php think trr:doc

Результат: документация успешно создана. Путь к файлу: api-doc.html.

Внимание!

Демонстрационные адреса

• Официальный сайт для запуска примера: демонстрационный сайт.
• Официальная документация по API в формате Markdown: демонстрационная страница.
• Официальная документация по HTML-API: демонстрационная страница.
• Локальный запуск примера: http://127.0.0.1:8000/.
• Локальная документация по API в формате Markdown: http://127.0.0.1:8000/apiShow.
• Локальная документация по HTML-API: http://127.0.0.1:8000/apiView.

Поддержка и вопросы

Обновления

Если у вас есть какие-либо вопросы или проблемы, пожалуйста, свяжитесь с нами. Мы будем рады помочь вам. Поскольку TRR в настоящее время находится на стадии непрерывной итерации и обновления, версия TP5.1 также постоянно отслеживается, поэтому содержание этого документа будет увеличиваться или корректироваться по мере адаптации.

Записи об обновлении проекта можно посмотреть в CHANGELOG.md.

Улучшение

Ограничиваясь личными техническими навыками и способностями к написанию, если читатели считают, что в учебнике есть какие-либо ошибки или что-то непонятно, они могут предложить более подробное объяснение.

Запрос на обновление, вопросы и общение

Если у читателей есть какие-либо вопросы или предложения относительно этого учебника или проекта GitHub, они могут создать issues в репозитории автора на GitHub.

Или

Присоединиться к официальной группе TRR QQ: 860613750.

Пригласите меня на чай

Если вы считаете, что этот проект вам помог, и хотите пригласить автора на чашку чая, пожалуйста, отсканируйте код и сделайте пожертвование любой суммы.

Информация о правах

TRR выпущен под открытой лицензией MIT и доступен для бесплатного использования.

Информация об авторских правах сторонних исходных кодов и двоичных файлов, включённых в этот проект, указана отдельно.

Авторские права © 2006–2019 TRR

Все права защищены.