{"id":20144186,"url":"https://github.com/quansitech/qscmf-api","last_synced_at":"2026-05-12T06:38:18.514Z","repository":{"id":38341422,"uuid":"399667865","full_name":"quansitech/qscmf-api","owner":"quansitech","description":"restful api","archived":false,"fork":false,"pushed_at":"2023-05-08T08:06:24.000Z","size":50,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-25T17:21:31.716Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quansitech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-25T02:40:53.000Z","updated_at":"2022-01-05T08:04:21.000Z","dependencies_parsed_at":"2024-11-13T22:09:10.184Z","dependency_job_id":"398167f8-a66e-4a5f-b364-3fabf4160091","html_url":"https://github.com/quansitech/qscmf-api","commit_stats":{"total_commits":26,"total_committers":2,"mean_commits":13.0,"dds":"0.11538461538461542","last_synced_commit":"8ebcf278e2f63729e8c21fd120b52f9167d3f6ae"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quansitech%2Fqscmf-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quansitech%2Fqscmf-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quansitech%2Fqscmf-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quansitech%2Fqscmf-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quansitech","download_url":"https://codeload.github.com/quansitech/qscmf-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241587914,"owners_count":19986627,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T22:09:05.877Z","updated_at":"2026-05-12T06:38:13.486Z","avatar_url":"https://github.com/quansitech.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# qscmf-api\n\nAPI开发集成库，自身内置接口开发规范，类restful的接口规范（接口命名方面不完全遵守），并且绑定swagger说明文档工具\n\n\n## 安装\n\n```\ncomposer require quansitech/qscmf-api\n```\n\n## swagger接口文档工具\n\n捆绑swagger工具，可通过  http://域名/extendApi/help 来访问swagger配置\n\n[swagger使用文档](https://github.com/zircote/swagger-php)\n\n\n## 用法\n+ [Api-API开发集成库](https://github.com/quansitech/qscmf-api/blob/master/docs/Api.md)\n+ [CrossApi-用于管理其他系统访问的接口](https://github.com/quansitech/qscmf-api/blob/master/docs/CrossApi.md)\n\n\n#### 属性设置\n\n属性值在继承了RestController的类里进行设置\n\n| 属性            | 说明                                       | 格式                                                         |\n| :-------------- | :----------------------------------------- | :----------------------------------------------------------- |\n| filter          | 过滤请求，只有通过了才能进行业务数据的访问 | 二维数组  [['id', 'isExists', 'Order', 404], ['item_id', 'isExists', 'Item', 404]] \u003cbr /\u003e目前仅支持isExists，检查数据库表有无对应的记录，没有则返回设置的http状态码 |\n\n\n#### restful规范的语义化请求\n\n1. get 表示获取信息 ，对应controller的gets方法\n2. post 表示创建信息，对应controller的create方法\n3. put 表示编辑信息, 对应controller的update方法\n4. delete 表示删除信息，对应controller的delete方法\n\n\n#### 版本控制\n\n通过在http请求头的accept里加入version=1.2.1之类的版本号来控制接口的请求路由\n\n如get请求，在accept 的位置加入 version=1.2.1，那么就会匹配到controller的  gets_v1_2_1的方法\n\n\n#### 内置方法\n\n| 方法名                | 说明                   | 参数                                                         | 返回值                                                       |\n| :-------------------- | :--------------------- | :----------------------------------------------------------- | ------------------------------------------------------------ |\n| response              | 返回请求内容           | message  提示信息\u003cbr /\u003estatus 类型标记\u003cbr /\u003edata 返回的具体内容\u003cbr /\u003ecode http状态码，默认值 200\u003cbr /\u003eextra_res_data 额外需要返回的数据，默认为空数组 | 返回json或者xml等格式的字符串（根据请求的资源类型而定）\u003cbr /\u003e{  'info': 'message内容', 'status': 1, 'data': 'data的json格式内容', 'extra_res_data':'自定义返回内容'} |\n| checkRequired         | 必填验证               | data 需要验证的数组\u003cbr /\u003erequired_list 必填的字段设置，有两种格式，直接举例说明： 1. [ 'id', 'name'] 表示id, name字段都是必填，如果没有填写，自动返回\"id必填\"这样的错误提示。 2. [ 'title'=\u003e '文章标题', 'type' =\u003e '文章类型'], 表示 title, type都是必填字段，后面的value值表示对应字段的中文描述，如没有传递type字段，会自动返回“文章类型必填”的错误提示，这样用户更容易理解错误信息。 | 验证不通过，直接response错误信息，否则返回true               |\n\n\n#### 设置值\n\n设置值可以在 app/Common/Conf/config.php 里设置\n\n| 设置值                      | 说明                      | 默认值                                                       |\n| :-------------------------- | :------------------------ | :----------------------------------------------------------- |\n| QSCMFAPI_SWAGGER_DIR        | 记录了swagger注释的文件夹 | [ROOT_PATH . '/app/Api/Controller', ROOT_PATH . '/app/Common/Model'] |\n\n\n#### 使用缓存机制\n+ [缓存使用说明](https://github.com/quansitech/qscmf-api/blob/master/docs/Cache.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquansitech%2Fqscmf-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquansitech%2Fqscmf-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquansitech%2Fqscmf-api/lists"}