PhalApi-iView-admin, открытый бэкенд-фреймворк

Основные технологии:

• PhalApi, открытый фреймворк для интерфейса.
• iView-admin, система управления на основе iView.

Основная особенность проекта — соответствие основной идее разделения фронтенда и бэкенда, сочетание PhalApi, ориентированного на интерфейс, и популярного iView. В настоящее время используются новейшие технологии, включая PhalApi 2.4.2, iView-admin 2.3.0, PHP 7, Vue и другие.

Приглашаем всех присоединиться к открытому исходному коду!

Онлайн-доступ

Онлайн-демо доступно по адресу: http://iview-admin.phalapi.net/.

Фронтенд (интерфейс iView)

Установка

// install dependencies
npm install

Запуск

Среда разработки

Используется при локальной отладке:

npm run dev

Производственная среда

Используется при сборке и публикации:

npm run build

Для получения дополнительной помощи и инструкций посетите iView-admin.

Бэкенд (интерфейс PHP)

Установка

Настройте сайт, если вы используете Nginx, следуйте этим инструкциям. Чтобы интегрировать PhalApi с iView-admin, есть два ключевых момента:

• Во-первых, корневой каталог сайта должен быть расположен в каталоге dist.
• Во-вторых, необходимо настроить перенаправление для интерфейсов, чтобы фронтенд мог получить доступ к бэкенду через относительные пути.

server {
        listen 80;
        server_name iview-admin.phalapi.net;

        index index.html;
        root /path/to/phalapi-iview-admin/dist;

        # 接口重定向
        rewrite ^/api/(.*) /api.php?s=$1 last;

        location ~ \.php$ {
                fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
                fastcgi_index index.php;
                include fastcgi_params;
                fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
        }

        access_log /var/log/nginx/iview-admin.phalapi.net.access;
        error_log /var/log/nginx/iview-admin.phalapi.net.error;
}

Два важных URL-адреса

После успешной локальной установки вы можете начать доступ. Предположим, что текущее настроенное доменное имя сайта — iview-admin.phalapi.net, тогда два важных URL-адреса:

• Домашняя страница панели управления: http://iview-admin.phalapi.net
• Документация онлайн-интерфейса: http://iview-admin.phalapi.net/docs.php

Имитация интерфейса, запросы интерфейса, реализация интерфейса и документация интерфейса

Имитация интерфейса

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

В файле ./src/mock/index.js определите интерфейсы, которые необходимо имитировать:

Mock.mock(/\/api\/Message.Count/, messageCount)

В файле ./src/mock/user.js можно вернуть имитированные данные:

 export const messageCount = () => {
  return 3
}

Запросы интерфейса

При запросе интерфейса из фронтенда вы можете обратиться к файлу ./src/api/user.js:

export const getUnreadCount = () => {
  return axios.request({
    url: 'api/Message.Count',
    method: 'get'
  })
}

Если запрашивается реальный интерфейс, например, URL-адрес запроса — http://iview-admin.phalapi.net/api/Message.Count, то возвращаемый результат интерфейса будет следующим:

{"ret":200,"data":3,"msg":""}

Здесь, в ./src/libs/axios.js, уже реализована совместимость между режимами разработки и производства.

Реализация интерфейса

Соответствующий код интерфейса PHP находится в файле: ./phalapi/src/app/Api/Message.php. Соответствующий фрагмент кода выглядит следующим образом:

 <?php
namespace App\Api;
use PhalApi\Api;

/**
 * 消息接口
 */
class Message extends Api {
    /**
     * 新消息数量
     */
    public function count() {
        return 3;
    }
}    

Документация интерфейса

Автоматически сгенерированная онлайн-документация интерфейса доступна по адресу: http://iview-admin.phalapi.net/docs.php?service=App.Message.Count&detail=1&type=fold. Эффект следующий:

Дополнительную помощь и инструкции можно найти на PhalApi.

Как обновить iView-admin?

Вы можете напрямую обновить зависимости npm, выполнив следующую команду:

$ npm update

Если есть другие обновления, обновите исходный код соответствующим образом.

Как обновить PhalApi?

Если в PhalApi есть обновления, вы можете перейти в каталог phalapi и выполнить обновление. Выполните следующие команды:

$ cd phalapi
$ composer update

Перед обновлением убедитесь, что версия PhalApi в файле ./phalapi/composer.json является последней. Если есть другие обновления, обновите исходный код соответствующим образом.

Лицензия

Этот проект в основном использует лицензию iView-admin с открытым исходным кодом, а именно MIT.