TRR

TRR

Краткое описание

Что такое TRR?

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

Для чего нужен TRR?

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

Фокус на том, чтобы:

• Разрабатывать интерфейсы 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. Запустите проект

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

php think run -H 127.0.0.1 -p 8000

Если вы увидите следующий вывод, запуск встроенного сервиса прошёл успешно:

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

• Генерация из командной строки

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

php think trr:doc

Результат:

F:\project\open-source-object\Trr\2019-7-6\TRR [master ≡ +0 ~217 -0 !]
λ  php think trr:doc
Successful. Output Document Successful . File Path ：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.

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

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

<p align="center">
    <img width="300"
    src='https://china-wangyu.github.io//TRR/打赏/alipay.jpg'
     alt='Пригласите автора на чай' />
</p>

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

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

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

Copyright © 2006–2019 by TRR

All rights reserved.