PHP7.2 + TP5.1 + Restful Api ，构建的API项目架构，支持API文档输出、API接口自检、开启API JWT模式、反射路由模式、API参数自检等功能

最新推荐文章于 2024-08-27 07:43:00 发布

你没心怎知我绝情

最新推荐文章于 2024-08-27 07:43:00 发布

阅读量941

点赞数 1

分类专栏： PHP restful api 文章标签： TP5.1 Restful API PHP7.2 接口自检接口文档

本文链接：https://blog.csdn.net/qq_40013999/article/details/89178024

版权

本文档介绍了如何使用PHP7.2和TP5.1构建支持RESTful API的项目，包括API文档输出、接口自检、JWT模式、反射路由和参数自检等功能。详细阐述了安装教程、使用说明，以及如何开启JWT模式和自检API接口。

摘要由CSDN通过智能技术生成

TP5.1 Restful Api

介绍

PHP7.2 + TP5.1 + Restful Api ，构建的API项目架构，支持API文档输出、API接口自检、开启API JWT模式、反射路由模式、API参数自检等功能

为了本项目拥有更加直白与客观的简易性、阅读性、实用性，所用的扩展和第三方代码，均未考虑高度抽象和深度封装，各位大大可以很简单的看懂源码和框架设计。

如果有需要或涉及到高并发的服务架构，可以在issues提出，或者留言也行，我将参考大家的意愿，出一个版本或demo。

软件架构

软件架构说明

www  WEB部署目录（或者子目录）
├─application           应用目录
│  ├─api        接口模块目录（可以更改，但不建议：很麻烦，模块里面不建议写模型和视图）
│  │  ├─common.php      模块函数文件(接口函数推荐写在这里)
│  │  ├─controller      控制器目录
│  │  │  ├─v1          接口版本模块
│  │  │  ├─v...          接口版本模块
│  ├─common             公共模块目录（可以更改）
│  │
│  ├─command.php        命令行定义文件
│  ├─common.php         公共函数文件
│  └─provider.php       应用容器绑定定义
│  └─tags.php           应用行为扩展定义文件
│
├─config                应用配置目录
│  ├─api               模块配置目录
│  │  ├─app.php       应用配置
│  │
│  ├─api.php            接口配置
│  ├─app.php            应用配置
│  ├─cache.php          缓存配置
│  ├─cookie.php         Cookie配置
│  ├─database.php       数据库配置
│  ├─log.php            日志配置
│  ├─session.php        Session配置
│  ├─template.php       模板引擎配置
│  └─trace.php          Trace配置
│
├─route                 路由定义目录
│  ├─route.php          路由定义
│  └─...                更多
│
├─public                WEB目录（对外访问目录）
│  ├─index.php          入口文件
│  ├─router.php         快速测试文件
│  └─.htaccess          用于apache的重写
│
├─thinkphp              框架系统目录
│  ├─lang               语言文件目录
│  ├─library            框架类库目录
│  │  ├─think           Think类库包目录
│  │  └─traits          系统Trait目录
│  │
│  ├─tpl                系统模板目录
│  ├─base.php           基础定义文件
│  ├─console.php        控制台入口文件
│  ├─convention.php     框架惯例配置文件
│  ├─helper.php         助手函数文件
│  ├─phpunit.xml        phpunit配置文件
│  └─start.php          框架入口文件
│
├─extend                扩展类库目录
├─runtime               应用的运行时目录（可写，可定制）
├─vendor                第三方类库目录（Composer依赖库）
├─build.php             自动生成定义文件（参考）
├─composer.json         composer 定义文件
├─LICENSE.txt           授权说明文件
├─README.md             README 文件
├─think                 命令行入口文件

安装教程

克隆本项目代码

git clone git@gitee.com:china_wangyu/TP5.1-Restful-Api.git

进入项目工程

cd TP5.1-Restful-Api

使用composer更新项目扩展,提升项目安全性、可用性

推荐使用composer中国镜像源，具体操作见【文档】

composer update

使用说明

必须配置以下内容

配置api.php 与app.php

api.php 目录在 {项目}/config/api.php

app.php 目录在 {项目}/config/api/app.php

配置route.php

route.php 目录在 {项目}/route/api.php

如果不修改模块，请直接使用默认配置

开启JWT模式（可选）

配置api.php

// 是否开启授权验证
'API_AUTHORIZATION' => true,

修改Api.php项目基类(不建议修改)

<?php
/**
 * Created by User: wene<china_wangyu@aliyun.com> Date: 2019/4/3 Time: 16:36
 */

namespace app\api\controller\v1;

use think\restful\ApiAuthorization;

/**
 * Class Api API基类
 * @package app\api\controller\v1
 */
class Api extends \think\restful\Api
{
     
    protected function handle()
    {
     
        if (config('api.API_AUTHORIZATION')){
     
            // 开启JWT验证,执行业务代码
            if(!isset($this->param['jwt']) or !isset($this->param['signature'])) {
     
                // 没有jwt参数 或 signature 签名
                $this->error('400 缺少API授权信息~');
            }
            $jwtArr = ApiAuthorization::decode($this->param['jwt'],config('api.API_AUTHORIZATION_KEY'));
            $userJwtSignature = md5(join(',',$jwtArr['data']));
            if ($userJwtSignature !==