# ThinkPHP API

**Repository Path**: EthanCeng/thinkphp-api

## Basic Information

- **Project Name**: ThinkPHP API
- **Description**: 基于ThinkPHP，完成的一套CMS。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2024-02-21
- **Last Updated**: 2025-06-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ThinkPHP API

## 介绍

    THinkPHP CMS API，基于ThinkPHP 8 开发，快速，高效，简洁，支持多端的CMS系统。运行环境要求PHP7.4+，兼容PHP8.1

## 软件架构

- 1.入口 `index.php` 多应用模式
- 2.路由 `route` 路由控制访问接口地址，请求方法。方法内二次判断。
- 3.中间层架构 `middleware && BaseController` 并列结构（建议通过中间件处理）
- 4.`Validate` 校验器控制入参正确性
- 5.业务逻辑处理 `controller && service` 并列结构
- 6.`model`层由 `ORM` 模型处理
- 7.`Exception` 错误自定义处理
- 8.数据返回，统一格式`code | msg | data`
- 9.后台管理使用Vue搭建的的前后端分离，admin-vue目录下，无需部署，方便二次开发

### RESTFul API

> 不使用模板template 模式。开启路由强制模式，必须走路由。
> 并且抽离 BaseController 结偶逻辑

### APP 多应用

- index 默认模块入口
- admin 管理后台
- api 微信小程序，移动端等

```$javascript
/**
 * notify
 * 返回数据提中不能使用message字段，与TP6框架中冲突
 * vendor/topthink/framework/src/think/exception/Handle.php
 * message must string Handle strpos($message, ':')
 */
[
    'code' => Int 1,
    'msg' => 'String 消息内容',
    'data' => 'Array | Object 查询数据'
]
```

### code 返回值说明

- http status 400,200
- 2** 请求成功
- 4** 请求错误，妨碍服务器处理
- 400 错误请求
- 401 未授权，请求要求身份验证
- 403 禁止，服务器拒绝请求
- 404 未找到，服务器找不到请求资源
- 500 （服务器内部错误） 服务器遇到错误，无法完成请求。

> 请求成功返回状态码一律200，查询结果为空返回数据 `data` 为空

| code | 状态     |
|:----:|:-------|
| 200  | 正常     |
| 999  | 内部异常   |
|  其他  | 其他异常说明 |

## ThinkPHP 安装与更新

```shell
# 安装
composer create-project topthink/think tp

# 更新
composer update topthink/framework
```

## 使用说明

1. 导入数据库，配置系统配置文件
2. xxxx
3. xxxx

## 文档

[完全开发手册](https://doc.thinkphp.cn/v8_0/preface.html)

## 参与开发

请参阅 [ThinkPHP 核心框架包](https://github.com/top-think/framework)。

## 版权信息

ThinkPHP遵循Apache2开源协议发布，并提供免费使用。

本项目包含的第三方源码和二进制文件之版权信息另行标注。

版权所有Copyright © 2006-2021 by ThinkPHP (<http://thinkphp.cn>)

All rights reserved。

ThinkPHP® 商标和著作权所有者为上海顶想信息科技有限公司。

更多细节参阅 [LICENSE.txt](LICENSE.txt)