phalapi
PhalApi 2.23.2
Произношение: PAI Framework, Официальный веб -сайт: https://www.phalapi.net/
Элегантные и подробные документы разработки, специально подготовленные для PHPER, могут найти ответы, которые вы хотите в документации. Пожалуйста, смотрите: Documents Development Phalapi 2.x.
Используйте композитор, чтобы создать команду проекта для достижения установки в один щелчок.
$ composer create-project phalapi/phalapiТеплое напоминание: для использования композитора, пожалуйста, обратитесь к веб-сайту Composer китайский/Packagist China, полномасштабное зеркальное зеркальное зеркало.
В качестве альтернативы, ручная установка может быть выполнена. После загрузки и декакомпрессии этого кода проекта GIT выполните дополнительное обновление композитора, то есть:
$ composer updateЕсли вы используете Nginx, вы можете обратиться к следующей конфигурации.
server {
listen 80 ;
server_name dev.phalapi.net;
# 将根目录设置到public目录
root /path/to/phalapi/public;
charset utf-8;
location / {
index index.php;
}
location ~ .php$ {
fastcgi_split_path_info ^(.+.php)(/.+)$ ;
# 根据当前环境，选择合适的通讯方式
# fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
fastcgi_pass 127.0.0.1:9000;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name ;
}
}При настройке необходимо установить корневой каталог веб -сайта в публичный каталог и перезапустить Nginx после сохранения конфигурации.
Теплое напоминание: рекомендуется указать корневой путь доступа к/path/to/phalapi/public.
Как использовать базу данных MySQL, см. Для изменения конфигурации базы данных ./config/dbs.php .
return array (
/**
* DB数据库服务器集群 / database cluster
*/
' servers ' => array (
' db_master ' => array ( // 服务器标记 / database identify
' type ' => ' mysql ' , // 数据库类型，暂时只支持：mysql, sqlserver / database type
' host ' => ' 127.0.0.1 ' , // 数据库域名 / database host
' name ' => ' phalapi ' , // 数据库名字 / database name
' user ' => ' root ' , // 数据库用户名 / database user
' password ' => '' , // 数据库密码 / database password
' port ' => 3306 , // 数据库端口 / database port
' charset ' => ' UTF8 ' , // 数据库字符集 / database charset
' pdo_attr_string ' => false , // 数据库查询结果统一使用字符串，true是，false否
' driver_options ' => array ( // PDO初始化时的连接选项配置
// 若需要更多配置，请参考官方文档：https://www.php.net/manual/zh/pdo.constants.php
),
),
),
// 更多代码省略……
);Наконец, вам нужно добавить разрешения на запись в каталог времени выполнения. Для получения дополнительных инструкций по установке, пожалуйста, обратитесь к документации для загрузки и установки.
В Phalapi вы можете указать службу интерфейса, которая будет вызвана через параметр службы (короткое имя - параметр S). Например, доступ к службе интерфейса по умолчанию.
http://dev.phalapi.net/?s=App.Site.Index
Результат результата после запроса интерфейса аналогичен следующему:
{
"ret": 200,
"data": {
"title": "Hello PhalApi",
"version": "2.4.2",
"time": 1501079142
},
"msg": ""
}
Соответствующий код PHP находится в файле ./src/app/api/site.php, а фрагмент исходного кода выглядит следующим образом:
<?php
namespace App Api ;
use PhalApi Api ;
/**
* 默认接口服务类
* @author: dogstar <[email protected]> 2014-10-04
*/
class Site extends Api {
public function getRules () {
return array (
' index ' => array (
' username ' => array ( ' name ' => ' username ' , ' default ' => ' PhalApi ' , ' desc ' => '用户名' ),
),
);
}
/**
* 默认接口服务
* @desc 默认接口服务，当未指定接口服务时执行此接口服务
* @return string title 标题
* @return string content 内容
* @return string version 版本，格式：X.X.X
* @return int time 当前时间戳
* @exception 400 非法请求，参数传递错误
*/
public function index () {
return array (
' title ' => ' Hello ' . $ this -> username ,
' version ' => PHALAPI_VERSION ,
' time ' => $ _SERVER [ ' REQUEST_TIME ' ],
);
}
}Эффект работы заключается в следующем:
Phalapi автоматически генерирует документы интерфейса в режиме реального времени в реальном времени на основе конфигурации параметров и комментариев кода написанного вами интерфейса. Ссылка документа онлайн -интерфейса:
Эффект просмотра аналогичен следующему:
Эффект страницы сведений о документе интерфейса аналогичен следующему:
Поддерживает онлайн-тестирование интерфейса, запрашивая примеры описания, создание автономных документов HTML-интерфейса и обновлений в реальном времени.
./phalapi
├── README.md # 简介
├── bin # 脚本目录
├── config # 配置目录
│ ├── app.php # 应用配置
│ ├── dbs.php # 数据库配置
│ ├── di.php # 依赖服务配置
│ └── sys.php #系统配置
├── data # 数据库
│ └── phalapi.sql # 数据库安装时的文件
├── language # 翻译包
├── public # 对外访问的目录
│ ├── docs # 离线生成的HTML接口文档
│ ├── docs.php # 在线版接口文档访问入口
│ ├── index.php
│ ├── init.php # 全局初始化文件
│ ├── static # 静态资源
│ ├── uploads # 上传目录（需要有写入权限）
│ └── phalapi_logo.png # logo图片
├── runtime # 运行目录
│ ├── cache # 文件缓存
│ └── log # 文件日志
├── sdk # SDK包
├── src # 项目源代码，非常重要
│ ├── app # 接口源代码（遵循ADM模式）
│ │ ├── Api # 放置接口源代码，相当于控制器层
│ │ ├── Common # 公共代码目录，放置工具等
│ │ ├── Domain # 领域业务层，负责业务逻辑和处理
│ │ ├── functions.php # 公共函数库
│ │ └── Model # 数据源层，负责数据持久化存储及操作
│ └── view # 页面模板目录（如接口文档）
├── tests # 单元测试
└── vendor # composer包，不需要手动修改，通过composer install/update可进行安装和更新 Измените файл ./public/init.php , чтобы установить текущий язык.
// 翻译语言包设定-简体中文
PhalApi SL ( ' zh_cn ' );
// Setting language to English
PhalApi SL ( ' en ' );
Теплое напоминание: вышеуказанное расширение должно быть установлено через композитор перед использованием. Для получения дополнительной информации об использовании и разработке библиотек расширенного класса, пожалуйста, обратитесь к документу: Библиотека классов Phalapi Framework Extension.
Теплое напоминание: разница между плагинами приложений и расширением композиторов заключается в том, что плагины приложений более детализируют и имеют более конкретные функции. Они могут иметь не только базы данных, интерфейсы, интерфейсы, но и сотрудничать с другими терминалами и не подлежат спецификациям композиторов. Они являются методом разработки независимого изобретения и дизайна Phalapi. Для получения дополнительной информации, пожалуйста, обратитесь к следующему руководству по разработке плагина приложения.
Теплое напоминание: все вышеперечисленные продукты используют рамку с открытым исходным кодом Phalapi и независимо разработаны чиновником. Люди/команды/предприятия могут его использовать.
Если вы найдете какие -либо проблемы или какие -либо проблемы, отправьте здесь проблему.
Если хотите, пожалуйста, помогите мне дать мне звезду на Github или Mayun, и вы также можете пожертвовать Phalapi^_^.
Apache 2.0, Apache License-это протокол, принятый Apache, известной некоммерческой организацией с открытым исходным кодом. Этот протокол похож на BSD, а также поощряет обмен кодом и уважает авторские права оригинального автора и позволяет изменять код и повторную публикацию (в качестве открытого или коммерческого программного обеспечения).
Он был поддержан и модернизирован Guangzhou Guochuang Network Technology Co., Ltd.
