# ffapi

**Repository Path**: haierspi/ffapi

## Basic Information

- **Project Name**: ffapi
- **Description**: FAST FAST API by FF Framework
- **Primary Language**: PHP
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: http://www.ffapi.org/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-04-06
- **Last Updated**: 2021-06-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### FAST FAST API *by FF Framework*

###### 已支持特性：
-  简单且高效率
-  支持自动在线生成接口文档,规范文档
-  支持接口版本化
-  规范的错误返回机制
-  支持PHP7
-  MVC模式
-  灵活的组件系统
-  自由度高, 通过相应的写法 让接口 支持RestfulAPI等多种协议.
-  支持 Token & Sign 双认证机制,并对以上机制进行了速度优化
- 支持Controller下的单一action自定义认证机制

###### 后续开发计划

- 支持Swoole,提高QPS并发
- 在Swoole启动变量下支持 异步 IO, 异步 Redis 异步Mysql 
- 支持基于TCP协议的RPCAPI
- 支持task
- 支持API聚合请求功能(API打包请求并返回)

------------

### FFAPI接口自动WIKI文档编写规范

格式说明:
```php
    @name    {title}    {description} //API接口名称 API接口描述
    @method  {method}	{description} //请求方式
    @format  {type}		{description} //返回格式
    @param   {type}		{varname}	{is_require}	{description} //请求参数 is_require 取值范围 yes no
    @var     {type}		{varname}	{description}  //返回字段
    @other   {description}  //其他备注说明
    @example {[format]} {(status:code)} //返回示例   [format]  部分可以取消; status:可以取消 status取值范围 success error
    @author  {info} //作者
```

演示案例:
```php
/**
 *
 * @name 用户相关  用于用户登陆的相关接口
 *
 */


class userController extends AuthController
{


    /**
     *
     * @name  用户登陆 登陆相关的
     * @method POST/JSON
     * @return JSON
     * @param string account yes 账号
     * @param string[1,2] password yes 密码
     * @var int status 状态码 (成功 1 ;失败 0;)
     * @var string msg 状态信息
     * @var string memberdata
     * @other 本接口附带登陆COOKIE
     * @example
     * [JSON](success:{"status":1,"data":{"face":"63800205.jpg","name":"asd12","province":"266","city":"267","gender":"1","birthday":"1367401462","username":"admin"}})
     * @author haierspi
     *
     */
    public function actionLogin()
    {
        return ['code' => 1];
    }

}

```