PHPackages                             quansitech/qscmf-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. quansitech/qscmf-api

ActiveLibrary[HTTP & Networking](/categories/http)

quansitech/qscmf-api
====================

qscmf library api rest

v2.4.1(2w ago)01.4k↓79.5%2MITPHPPHP >=8.0

Since Aug 25Pushed 2w ago1 watchersCompare

[ Source](https://github.com/quansitech/qscmf-api)[ Packagist](https://packagist.org/packages/quansitech/qscmf-api)[ RSS](/packages/quansitech-qscmf-api/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependencies (4)Versions (19)Used By (0)

qscmf-api
=========

[](#qscmf-api)

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

安装
--

[](#安装)

```
composer require quansitech/qscmf-api

```

swagger接口文档工具
-------------

[](#swagger接口文档工具)

捆绑swagger工具，可通过 [http://域名/extendApi/help](http://%E5%9F%9F%E5%90%8D/extendApi/help) 来访问swagger配置

[swagger使用文档](https://github.com/zircote/swagger-php)

用法
--

[](#用法)

- [Api-API开发集成库](https://github.com/quansitech/qscmf-api/blob/master/docs/Api.md)
- [CrossApi-用于管理其他系统访问的接口](https://github.com/quansitech/qscmf-api/blob/master/docs/CrossApi.md)

#### 属性设置

[](#属性设置)

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

属性说明格式filter过滤请求，只有通过了才能进行业务数据的访问二维数组 \[\['id', 'isExists', 'Order', 404\], \['item\_id', 'isExists', 'Item', 404\]\]
目前仅支持isExists，检查数据库表有无对应的记录，没有则返回设置的http状态码#### restful规范的语义化请求

[](#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的方法

#### 内置方法

[](#内置方法)

方法名说明参数返回值response返回请求内容message 提示信息
status 类型标记
data 返回的具体内容
code http状态码，默认值 200
extra\_res\_data 额外需要返回的数据，默认为空数组返回json或者xml等格式的字符串（根据请求的资源类型而定）
{ 'info': 'message内容', 'status': 1, 'data': 'data的json格式内容', 'extra\_res\_data':'自定义返回内容'}checkRequired必填验证data 需要验证的数组
required\_list 必填的字段设置，有两种格式，直接举例说明： 1. \[ 'id', 'name'\] 表示id, name字段都是必填，如果没有填写，自动返回"id必填"这样的错误提示。 2. \[ 'title'=> '文章标题', 'type' => '文章类型'\], 表示 title, type都是必填字段，后面的value值表示对应字段的中文描述，如没有传递type字段，会自动返回“文章类型必填”的错误提示，这样用户更容易理解错误信息。验证不通过，直接response错误信息，否则返回true#### 设置值

[](#设置值)

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

设置值说明默认值QSCMFAPI\_SWAGGER\_DIR记录了swagger注释的文件夹\[ROOT\_PATH . '/app/Api/Controller', ROOT\_PATH . '/app/Common/Model'\]#### 使用缓存机制

[](#使用缓存机制)

- [缓存使用说明](https://github.com/quansitech/qscmf-api/blob/master/docs/Cache.md)

###  Health Score

51

—

FairBetter than 95% of packages

Maintenance96

Actively maintained with recent releases

Popularity18

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 82.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~103 days

Recently: every ~286 days

Total

18

Last Release

19d ago

Major Versions

v1.3.5 → v2.0.02022-09-16

PHP version history (2 changes)v1.0.0PHP >=7.2

v2.0.0PHP >=8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/15a0610fee78753bdad92fd45c3506455c0fd45ae51924797b1841d260495a3f?d=identicon)[tiderjian](/maintainers/tiderjian)

---

Top Contributors

[![Xhiny](https://avatars.githubusercontent.com/u/35066497?v=4)](https://github.com/Xhiny "Xhiny (48 commits)")[![tiderjian](https://avatars.githubusercontent.com/u/1665649?v=4)](https://github.com/tiderjian "tiderjian (7 commits)")[![1041729157](https://avatars.githubusercontent.com/u/35829078?v=4)](https://github.com/1041729157 "1041729157 (3 commits)")

---

Tags

apirestqscmf

### Embed Badge

![Health badge](/badges/quansitech-qscmf-api/health.svg)

```
[![Health](https://phpackages.com/badges/quansitech-qscmf-api/health.svg)](https://phpackages.com/packages/quansitech-qscmf-api)
```

###  Alternatives

[nelmio/api-doc-bundle

Generates documentation for your REST API from attributes

2.4k67.4M264](/packages/nelmio-api-doc-bundle)[outeredge/swagger-module

Laminas Framework Module for Swagger resource file generation

23113.1k](/packages/outeredge-swagger-module)[phplist/rest-api

A REST API for phpList, the world's most popular open source newsletter manager

243.3k1](/packages/phplist-rest-api)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)