# EcmsAPI

**Repository Path**: LYNKCOL/ecmsapi

## Basic Information

- **Project Name**: EcmsAPI
- **Description**: 帝国7.5，EcmsAPI开发包搭建。以对象开发形式，使用php自动加载(也可以composer包管理)，让代码写的更少，php版本大于等于5.6以上为佳。
- **Primary Language**: PHP
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: http://coach.twoir.com/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 4
- **Created**: 2024-08-15
- **Last Updated**: 2024-08-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# EcmsAPI

## 帝国API介绍

### 插件特点如下：

1. 使用php特性自加载功能，或使用composer包管理工具，任选一种;
2. 除入口文件，其余全部采用类文件编写，错误已全部通过异常处理接管，逻辑更简洁、更高效(每一个代码不重复写);
3. 版本控制更加灵活(/api/v1/),安全性更高，做到一次性安全过虑，如v2,v3;
4. 自动联表处理，写sql语句时不用关心主、副表及模型表已审核/待审核/存档表位置等，支持批量处理插入数据(将在下一个版本可能会更新);
5. 附加基本功注册、登陆、退出、验证码、授权接口、公众号授权、小程序授权，sitemap生成(含html,xml,txt)，JWT；(不定期发布、更新);
6. 后台可以编辑Controller文件夹(接口权限控制)和Model文件夹(字段维护)，如出于安全可以选择关闭(暂时未上线)；

### 插件目录结构如下

```
upload/
└── api/
╌╌╌ └── v1/ (api入口)
└── e/
╌╌╌ └──	extend/	
╌╌╌	╌╌╌	└── twoir/
╌╌╌	╌╌╌	╌╌╌	├──	class/ (核心目录)
╌╌╌	╌╌╌	╌╌╌	└──	config/
╌╌╌	╌╌╌	╌╌╌ ╌╌╌ └──	...
╌╌╌	╌╌╌	╌╌╌ autoload.php (自动加载)
```

新站可以直接覆盖

### 安装环境安要

1、PHP5.6以上版本
2、帝国ecms 7.5


### 安装教程

#### 第一步，复制文件到指定位置

将upload目录下有文件复制根目录,如果是新安装直接覆盖即可。

#### 第二步，安装自动加载功能

在`class`目录的`connect.php`文件中 加入以下代码

在10行左右(中间代码)

```
-----开始-----
/**
 * 2021.09.01 自动载功能
 * cighsen02 365182575
 **/
define('EXTEND_DIR', ECMS_PATH . 'e' . DIRECTORY_SEPARATOR . 'extend');
require_once EXTEND_DIR . DIRECTORY_SEPARATOR . 'twoir' . DIRECTORY_SEPARATOR . 'autoload.php';
----结束-----
```

#### 第三步，后台接口管理菜单

在后台系统设置里<扩展菜单> -> <管理菜单>：

 ---- 暂时不开放，后续考虑增加


### 其它相关

1. 更多教程： http://coach.twoir.com/ecms/api/

2. 帝国原版UI演示城市分站 [演示站](http://test.959602.com/)

3. 省市区，带有周边城市功能演示城市分站 [演示站](https://zhan.cn.sj42.com/)


### 更新日志

#### 2024.05.01

1. 统一入口，前后台分流API;
2. API登陆、退出、注册及收藏等基础功能;
3. 简化信息调用参数，合并及简化，让参数传的更少;
4. `SingleTrait`更新，可对分表选择指定位置，例评论表选择;
5. 增加base64形式，api验证码显示，必要时api也可以使用验证码，防止暴力写入数据;
6. 增加一个助手函数文件helper.php，让入口文件里更干净，函数写到助手文件里。

#### 2023.06.07

1. 改进`BaseInfo`函数，专注模型调用。

#### 2023.04.17

1. 方便，快捷、轻量api接口首次发布，暂时提供新闻模板调用示例。
  
### 参与贡献

1.  版本号说明：中间一位代表php版本系列，php7，则v1.7.x，v1.5.1适用php5.6版的
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request