phalapi
PhalApi 2.23.2
Prononciation: Framework PAI, site officiel: https://www.phalapi.net/
Les documents de développement élégants et détaillés spécialement préparés pour PHPER peuvent essentiellement trouver les réponses que vous souhaitez dans la documentation. Veuillez consulter: Phalapi 2.x Documents de développement.
Utilisez Composer pour créer une commande de projet pour réaliser une installation en un clic.
$ composer create-project phalapi/phalapiRappel chaud: Pour l'utilisation du compositeur, veuillez vous référer à la mise en miroir à grande échelle du site Web du compositeur chinois / Packagist.
Alternativement, l'installation manuelle peut être effectuée. Après avoir téléchargé et décompressé ce code de projet GIT, effectuez une mise à jour du compositeur en option, c'est-à-dire:
$ composer updateSi vous utilisez Nginx, vous pouvez vous référer à la configuration suivante.
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 ;
}
}Lors de la configuration, vous devez définir le répertoire racine du site Web sur le répertoire public et redémarrer Nginx après l'enregistrement de la configuration.
Rappel chaud: il est recommandé de pointer le chemin de la racine d'accès à / path / vers / phalapi / public.
Comment utiliser la base de données MySQL, reportez-vous à Modifier la configuration de la base de données ./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
),
),
),
// 更多代码省略……
);Enfin, vous devez ajouter des autorisations d'écriture au répertoire d'exécution. Pour plus d'instructions d'installation, veuillez vous référer à la documentation pour télécharger et installer.
Dans Phalapi, vous pouvez spécifier le service d'interface à appeler via le paramètre de service (le nom court est le paramètre S). Par exemple, accédez au service d'interface par défaut.
http://dev.phalapi.net/?s=App.Site.Index
La sortie du résultat après la demande d'interface est similaire à ce qui suit:
{
"ret": 200,
"data": {
"title": "Hello PhalApi",
"version": "2.4.2",
"time": 1501079142
},
"msg": ""
}
Le code PHP correspondant se trouve dans le fichier ./src/app/api/site.php, et le fragment de code source est le suivant:
<?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 ' ],
);
}
}L'effet de fonctionnement est le suivant:
Phalapi générera automatiquement des documents d'interface en ligne en temps réel en fonction de la configuration des paramètres et des commentaires de code de l'interface que vous avez écrite. Le lien de document d'interface en ligne est:
L'effet de navigation est similaire à ce qui suit:
L'effet de la page Détails du document d'interface est similaire à ce qui suit:
Prend en charge les tests d'interface en ligne, la demande de descriptions d'échantillons, la génération de documents d'interface HTML hors ligne et les mises à jour en temps réel.
./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可进行安装和更新 Modifiez le fichier ./public/init.php pour définir la langue actuelle.
// 翻译语言包设定-简体中文
PhalApi SL ( ' zh_cn ' );
// Setting language to English
PhalApi SL ( ' en ' );
Rappel chaud: l'extension ci-dessus doit être installée via le compositeur avant utilisation. Pour plus d'informations sur l'utilisation et le développement des bibliothèques de classe étendues, veuillez vous référer au document: bibliothèque de classe d'extension Phalapi Framework.
Rappel chaud: La différence entre les plug-ins d'application et les extensions des compositeurs est que les plug-ins d'applications sont plus granulaires et ont des fonctions plus spécifiques. Ils peuvent non seulement avoir des bases de données, des interfaces, des interfaces, mais aussi coopérer avec d'autres bornes et ne sont pas soumises aux spécifications du compositeur. Ils sont la méthode de développement de l'invention et de la conception indépendantes de Phalapi. Pour plus d'informations, veuillez vous référer à: Tutoriel de développement du plug-in de l'application tiers.
Rappel chaud: Tous les produits ci-dessus utilisent le cadre open source Phalapi et sont développés indépendamment par le fonctionnaire. Les individus / équipes / entreprises sont invités à l'utiliser.
Si vous trouvez des problèmes ou des problèmes, veuillez soumettre un problème ici.
Si vous le souhaitez, aidez-moi, aidez-moi à me donner une étoile sur Github ou Mayun, et vous pouvez également faire un don à Phalapi ^ _ ^.
Apache 2.0, la licence Apache est un protocole adopté par Apache, une célèbre organisation open source à but non lucratif. Ce protocole est similaire à BSD et encourage également le partage de code et respecte le droit d'auteur de l'auteur d'origine, et permet la modification et la rediffusion du code (en tant que logiciel open source ou commercial).
Il a été maintenu et amélioré par Guangzhou Guochuang Network Technology Co., Ltd. depuis longtemps.
