PHPRAP — это легковесная система управления документацией по API-интерфейсам с открытым исходным кодом на PHP, которая направлена на снижение затрат на коммуникацию между фронтендом и бэкендом, повышение эффективности командной разработки и создание PHP-версии RAP.
Версия:
Связанные ресурсы:
Особенности:
- разработка на основе Yii2-фреймворка, рациональная архитектура, превосходная производительность и высокая степень повторного использования и расширяемости;
- простая установка, предоставляющая онлайн-установщик, который требует только заполнения небольшого количества информации для завершения установки и развёртывания;
- простота в использовании, аналогичная Ally RAP, обеспечивает отличный пользовательский опыт и позволяет начать работу за одну минуту;
- построен на Bootstrap, идеально подходит для ПК, планшетов и мобильных устройств;
- проектные заявки отправляются в режиме реального времени, что удобно для обработки заявок создателями проектов;
- полный журнал операций проекта, обеспечивающий прозрачность всего процесса проекта;
- совершенная система контроля доступа, позволяющая отдельно контролировать права участников на проекты, среды, модули и интерфейсы;
- поддержка онлайн-отладки интерфейсов, автоматически заполняет предопределённые заголовки и параметры запросов, избавляя от необходимости вручную добавлять параметры в Postman для отладки интерфейса;
- предоставление услуг MOCK, автоматическое создание имитированных данных на основе документации по интерфейсу, поддержка сложных логических процессов генерации, протоколов запросов, методов запросов и форматов проверки параметров запросов;
- богатые типы данных MOCK, включая случайные тексты, числа, логические значения, даты, электронные письма, ссылки, изображения, цвета, китайские имена, номера телефонов, цены, адреса электронной почты, веб-сайты и т. д.;
- возможность экспорта всей проектной документации в HTML одним щелчком мыши для удобства просмотра в автономном режиме;
- возможность экспортировать документацию по отдельным интерфейсам в HTML для удобства просмотра в офлайн-режиме;
- открытый исходный код и бесплатное использование, а также непрерывное предоставление бесплатных технических услуг сообщества.
Зависимости:
- PHP >= 7.0.0;
- MySQL >= 5.1.0;
- расширение PDO;
- расширение GD;
- расширение CURL;
- расширение OPENSSL.
Установка:
- Загрузите программу в корневой каталог.
- GITEE (рекомендуется):
git clone https://gitee.com/gouguoyin/phprap.git
- GitHub:
git clone https://github.com/gouguoyin/phprap.git
- Исходный код:
Скачайте исходный код по ссылке https://gitee.com/gouguoyin/phprap/repository/archive/master.zip, распакуйте его и перенесите все файлы исходного кода в каталог phprap в корневую директорию.
- Установите права доступа к каталогу:
- каталог runtime и его подкаталоги должны иметь права на чтение и запись;
- файл configs/db.php должен иметь права на чтение и запись.
- Скройте файл входа index.php:
- IIS: если ваш сервер поддерживает ISAPI_Rewrite, вы можете настроить файл httpd.ini, добавив следующий контент:
RewriteRule (.*)$ /index\.php\?r=$1 [I]
<rewrite>
<rules>
<rule name="OrgPage" stopProcessing="true">
<match url="^(.*)$" />
<conditions logicalGrouping="MatchAll">
<add input="{HTTP_HOST}" pattern="^(.*)$" />
<add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
<add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
</conditions>
<action type="Rewrite" url="index.php?r=/{R:1}" />
</rule>
</rules>
</rewrite>
- Apache: загрузите модуль mod_rewrite.so в файл конфигурации httpd.conf и измените AllowOverride None на AllowOverride All. Если программа развёрнута в корневом каталоге, настройте правила перезаписи в файле .htaccess:
<IfModule mod_rewrite.c>
RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ index.php?r=/$1 [QSA,PT,L]
</IfModule>
<IfModule mod_rewrite.c>
RewriteEngine on
RewriteCond %{REQUEST_URI} !^/sub_dir/
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ /sub_dir/index.php?r=/$1 [QSA,PT,L]
</IfModule>
- Nginx: если программа развёрнута в корневом каталоге, настройте правила перезаписи в Nginx.conf:
location / {
if (!-e $request_filename) {
rewrite ^(.*)$ /index.php?r=$1 last;
break;
}
}
location /sub_dir/ {
if (!-e $request_filename){
rewrite ^/sub_dir/(.*)$ /sub_dir/index.php?r=$1 last;
}
}
- Откройте браузер и перейдите к доменному имени, чтобы автоматически перейти к программе установки для запуска программы установки.
- Шаг 1 установки: проверка среды.
- Шаг 2 установки: настройка базы данных.
- Шаг 3 установки: конфигурация администратора.
- Шаг 4 установки: завершение установки. Логин история
Проект
- Новый проект
- Редактировать проект
- Поиск проекта
- Переключить проект
- Главная страница проекта
- Удалить проект
- Экспорт HTML
- История проекта
Модуль
- Создать модуль
- Изменить модуль
- Удалить модуль
Интерфейс
- Домашняя страница интерфейса
- Создать интерфейс
- Редактирование интерфейса
- Удаление интерфейса
- Редактирование поля
- Импорт поля
- Экспорт HTML
Бэкенд
- Главная страница управления
- Управление проектом
- Управление корзиной
- Управление пользователями
- Логин история
- Системные настройки
Контакты
Если у вас есть какие-либо вопросы или предложения во время использования, пожалуйста, свяжитесь со мной через следующие каналы или создайте Issue, чтобы обсудить новые функции или изменения.
Пожертвование
Если вам нравится, поддержите автора чашкой кофе. Разработка с открытым исходным кодом — это непросто, ваша поддержка — моя движущая сила!
[Платёж через WeChat]
[Платёж через Alipay]
Комментарии ( 0 )