quansitech/qscmf-api

qscmf library api rest

v2.2.1 2023-04-28 09:09 UTC

Requires

• php: >=8.0
• tiderjian/think-core: >=12.27.0
• zircote/swagger-php: ^3.0

MIT

• tiderjian

• rest
• api
• qscmf

README

API开发集成库，自身内置接口开发规范，类restful的接口规范（接口命名方面不完全遵守），并且绑定swagger说明文档工具

安装

composer require quansitech/qscmf-api

swagger接口文档工具

捆绑swagger工具，可通过 http://域名/extendApi/help 来访问swagger配置

swagger使用文档

用法

• Api-API开发集成库
• CrossApi-用于管理其他系统访问的接口

属性设置

属性值在继承了RestController的类里进行设置

restful规范的语义化请求

1. get 表示获取信息 ，对应controller的gets方法
2. post 表示创建信息，对应controller的create方法
3. put 表示编辑信息, 对应controller的update方法
4. delete 表示删除信息，对应controller的delete方法

版本控制

通过在http请求头的accept里加入version=1.2.1之类的版本号来控制接口的请求路由

如get请求，在accept 的位置加入 version=1.2.1，那么就会匹配到controller的 gets_v1_2_1的方法

内置方法

设置值

设置值可以在 app/Common/Conf/config.php 里设置

使用缓存机制

• 缓存使用说明