3 Star 6 Fork 2

嗝嗝 / think-restful

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
Apache-2.0

tp-rest-api

star fork Fork me on Gitee

介绍

ThinkPHP 5.1的restful接口composer扩展

软件架构

软件架构说明

think         模块目录
    ├─ restful        核心目录
        ├─ command              API命令行
            ├─ Check.php        Api接口自检命令行脚本
            ├─ Make.php         Api接口文档命令行脚本
        ├─ curl                 API 封装的CURL
            ├─ Curl.php         Api 封装的CURL请求类
        ├─ exception            exception 异常捕获封装
            ├─ ApiException.php Api 异常捕获封装类
        ├─ helper               exception 接口助手
            ├─ Helper.php       Api 接口助手工具类
        ├─ jwt                  JWT 接口授权
            ├─ Jwt.php          Api JWT接口授权类
        ├─ reflex               接口反射
            ├─ Reflex.php       Api 接口反射类
        ├─ response             接口响应
            ├─ Json.php         Api 接口响应类
        ├─ route                路由
            ├─ Route.php       Api 接口路由类
        ├─ validate            验证模型
            ├─ Api.php         Api 验证类
            ├─ Authorize.php   Api 权限验证类
            ├─ Host.php        Api 网址验证类
            ├─ Param.php       Api 接口参数验证类
            ├─ Route.php       Api 路由验证类
        ├─Api.php               API 基类 (继承这个类就好了)
        ├─Base.php              扩展Base类
        
api.php API restful 风格配置文件,主要用于配置一些默认值等

app.php API 项目配置文件,主要用于配置项目异常转发和是否开启debug模式。

安装教程

composer 安装

  • 使用国内镜像
"repositories": {
    "packagist": {
      "type": "composer",
      "url": "https://packagist.phpcomposer.com"
    }
  }
  • 安装 china-wangyu/think-restful 扩展
composer require china-wangyu/think-restful

使用说明

本Restful API接口扩展包,使用的自建反射路由模式,默认格式为:

/**
* @doc 获取服务器授权1
* @route /api/v1/auth get
* @param string $appSecret 授权字符 require|alphaNum
* @param string $appSec2t 授权字符1 require|alphaNum
* @param string $appId 开发者ID
* @success {"code":400,"msg":"appSecret不能为空","data":[]}
* @error {"code":400,"msg":"appSecret不能为空","data":[]}
*/
public function read()
{
 return $this->success('成功~');
}

参数说明

@ 名称 参数1注解 参数2注解 参数3注解
doc API接口文档
route API路由规则 请求类型
param api参数 验证规则 默认值
success API请求成功返回json示例
error API请求失败返回json示例
  1. 必须是 PHP7.2 版本及以上

  2. 必须是 TP5.1.0 版本以上

  3. 首先用 composer 安装 china-wangyu/think-restful

  4. 注册TP5.1路由

    {项目}/route/route.php

    \think\restful\route\Route::register('api');
  5. 配置扩展的 TP5.1 配置文件

    创建文件. {项目}/config/api.php

    内容:

    {扩展目录}/api.php 内容

    创建文件. {项目}/config/app.php

    内容:

       {扩展目录}/app.php 内容
  6. 创建API基类,便于验证授权

    cp {扩展目录}/Base.php  {项目目录}/applicaition/api/controller/{接口版本}/Base.php
  7. 配置 API 类继承 \app\api\controller\v1\Base

    例如:

    class Auth extends \app\api\controller\v1\Base

获取当前 API 方法,过滤后的参数

$this->param;

返回成功(json )

注意本扩展某些函数与TP的\think\Controller的一些函数一样

 return $this->success('成功~');

返回失败(json )

注意本扩展某些函数与TP的\think\Controller的一些函数一样

return $this->error('失败~');

开启 china-wangyu/think-restful 命令行

命令行工具使用请先关闭api.phpAPI_AUTHORIZATION

设置api.phpAPI_AUTHORIZATION=>false

'API_AUTHORIZATION' => false,

设置 TP5 命令行类

文件位置:{项目}/application/command.php

添加内容:

{扩展目录}/command.php 内容
  • 打开当前位置命令行窗口
cd {项目目录}
  • 检验命令行脚本是否输入成功
{项目地址}> php think
Think Console version 0.1
 ....
 api
   api:check          验证 API 并生成 API Debug 文档
   api:make           生成 API 接口文档,markdown 格式

输出接口文档 php think api:make

{项目地址} > php think api:make

API markdown 接口文档地址: C:\Users\zhns_\Desktop\php\TP5.1-Restful-Api\\API接口文档2019-04-16 15.md

输出接口自检 (有待改进)

我想这个功能我做的还不太完善,有待改进

  • 首先需要开启一个本地网站服务

    • 使用PHP内置服务器
    php -S {IP地址}:{端口} -t {项目目录}/public/
    • TP5 启动服务
    > php think run -H {IP地址} -P {端口}
    
    ThinkPHP Development server is started On <http://127.0.0.1:8000/>
    You can exit with `CTRL-C`
    Document root is: E:\VirtualBox\vms\CICD\labs\tp5restfulapi_architecture\public
  • 然后配置项目 api.php 配置文件的参数 (可选)

'API_HOST'=> 'http://127.0.0.1:8000',# 设置API网址
  • 命令行运行脚本命令 php think api:check

如果没有执行上一步操作,请在这加上-H 属性,并且设置属性值为:http://服务器网址:端口 例如:php think api:check -H http://172.16.14.62:8000

>  php think api:check -H http://172.16.14.62:8000

API markdown 自检文档地址: C:\Users\zhns_\Desktop\php\TP5.1-Restful-Api\\API自检文档2019-04-16 15.md

开启权限验证

  • 请开启 api配置文件的 API_AUTHORIZATION 属性为 true
// 是否开启授权验证
'API_AUTHORIZATION' => true,
  • 创建授权类,如下
cp {扩展目录}/Token.php  {项目目录}/applicaition/api/controller/Token.php

项目自评

本扩展或者说是一个TP5.1+PHP7.2的后端项目API架构, 主要是帮助刚刚入行或者快速建站的朋友们,进行项目快速迭代开发, 把接口授权、接口验证、参数校验、接口文档输出、接口自验包裹封装起来, 只为大家用的安心。

帮助作者

项目开发或者扩展开发,都需要不断地编码尝试与线上环境验证。 所需的资源和时间都是有成本的,如果项目帮助到您了, 如果您有心帮助作者,请点击下方的捐赠按钮

参与贡献

  1. Fork 本仓库
  2. 新建 ts_{用户名} 分支
  3. 提交代码
  4. 新建 Pull Request

联系作者

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

本扩展或者说是一个TP5.1+PHP7.2的后端项目API架构, 主要是帮助刚刚入行或者快速建站的朋友们,进行项目快速迭代开发, 把接口授权、接口验证、参数校验、接口文档输出、接口自验包裹封装起来, 只为大家用的安心。 expand collapse
PHP
Apache-2.0
Cancel

Releases

No release

Contributors

All

Activities

Load More
can not load any more
PHP
1
https://gitee.com/china_wangyu/think-restful.git
git@gitee.com:china_wangyu/think-restful.git
china_wangyu
think-restful
think-restful
master

Search