# PY_API

### 框架说明

- 使用技术： 本框架是基于ThinkPHP5，前端使用vue，vuetify，element等技术实现。
- 适合人群： 有一定php和vue的开发基础；或有其他开发经验能快速学习，也适合新手学习。
- 使用场景： 适合小型项目；例如快速建站，公众号开发，小程序开发等。
- 框架优势： 能够快速上手；不用webpack打包；学习成本低；针对小型项目能够快速产出；节约开发成本。

### 框架介绍

####  1. 安装

下载项目到本地配置的服务器运行目录；将doc文件夹中的数据库连接上，并将app/database.php里面的数据库配置上即可。

####  2. 目录结构

整体目录结构可阅读ThinkPHP的官方文档：https://www.kancloud.cn/manual/thinkphp5/118008。

这里我们主要以开发目录app进行介绍：

-  addons为外部插件目录；已有插件：七牛上传插件，阿里云短信插件，微信开发的一些API接口等。
-  common是公共模块的目录，这里是一些php和vue的公共方法。
-  manager是后台管理的目录，mobile通常作为微信开发的目录，vapp通常作为小程序开发的目录，web通常作为前端网站开发的目录。这里可以根据个人开发习惯灵活使用，每个目录做什么完全没有限制，下面以manager为例进行介绍。
-  api目录是写接口与前端进行交互；controller是控制器目录；view是前端页面目录；

####  3. 主要功能介绍

-   系统配置：使用缓存的方式，配置一些常用的参数，例如网站名称、描述、logo，微信配置等；可以快速调用，统一管理。
-   配置组：用于存放一些带有标签属性的值或者在实际开发中比较通用的属性，例如：一个教学系统中，课程的难度，科目，分类等；或者最常见的轮播图。使用配置组即可统一管理和维护，不必再去为了一个分类建一个表。
-   用户组/权限：为管理员分配菜单及API的使用权限。
-   全局API管理：在开发写接口时，需要先进行创建，选择接口使用在某个模块下的某个控制器，是否验证登录以及记录日志；对接口进行统一的管理。
-   栏目及文章管理：快速创建网站的栏目，以及栏目下文章的增删改；支持多级栏目管理。

![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/175537_90fdb1b4_3043377.png "屏幕截图.png")

### 开发教程

####  1. 如何进行开发

现在我们创建一个向后台请求并返回hello word的完整例子；

- ######  在后台菜单管理中创建业务菜单

![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/180547_c83cc227_3043377.png "屏幕截图.png")

- ######  创建子菜单，填写的链接。

![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/180552_a9fd68f0_3043377.png "屏幕截图.png")

- ######  根据填写的链接地址相应的在代码中进行创建，例如我们所填写的是home/hello，就需要在控制器下创建相应的Home.php，在view下的home文件夹创建hello.html。

![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/175816_625e1427_3043377.png "屏幕截图.png")

- ######  具体代码实现  Home.php文件，这里统一的layout到public/layout下；

![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/175836_35dfc989_3043377.png "屏幕截图.png")

- ######  为什么要统一的执行layout(‘public/layout’)呢。这里介绍一下前端vue在框架中的使用方式。在layout文件中创建一个vue实例，通过php的include方法引入需要的js文件（cssjs），再引入自定义的组件和全局方法（vue_template和api_fun），每个页面通过app_inside加载进来。这样在php加载不同的路径时，就会引入相应的app_inside。

- ######  layout文件：

![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/175857_40d651ad_3043377.png "屏幕截图.png")

- ######  hello文件：

![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/175906_c4ad2182_3043377.png "屏幕截图.png")

- ######  下面我们就通过hello.html中定义的hello方法去请求后台接口；

- ######  首先需要在后台的全局API管理中创建hello接口，这里我们创建在manager模块下的home控制器下；

![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/175917_7cb218b7_3043377.png "屏幕截图.png")

- ######  在相应的manager下api下的home中创建hello方法，这里我们直接返回hello word。

![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/175929_ebc525d6_3043377.png "屏幕截图.png")

- ######  可以看到hello word输出成功了

![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/175938_77c0c925_3043377.png "屏幕截图.png")

#### 2. 主要方法的使用

- ##### 缓存的使用
上面提到系统配置是使用缓存机制，那么接下来介绍如何去使用定义的这些字段，以系统中配置好的站点名称为例：

![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/180008_e79085c6_3043377.png "屏幕截图.png")

在php中使用：SC(‘site_title’) ；在前端使用时，通常我们会设置个全局变量（使用GV命名变量）去存储这些值，在使用的地方调用即可：GV.SITE_TITLE ；下面我们在hello.html中使用一下，看上去是不是很方便。

![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/180026_d090672e_3043377.png "屏幕截图.png")

![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/180030_1548e28f_3043377.png "屏幕截图.png")
- ##### 配置组的使用
首先在配置组管理中创建一个hello的分类，对于这个分类我们有几种使用方式：
        
-  调用分类中某一项的某一个值，这里使用的方法为GT(‘id.键值’)；id为所调用某个值的id，键值不写，将默认调用它的title属性；GT(‘id.*’)将返回全部属性值；输出时注意处理；
-  调用整个配置组，使用GT(‘配置组名’)；
-  通过接口调用，后台封装了com_get_tags方法，调用：com_get_tags(‘组名’)即可；接下来我们在hello.html文件中去使用它；

![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/180045_61809d8e_3043377.png "屏幕截图.png")
![输入图片说明](https://images.gitee.com/uploads/images/2019/0618/180051_aeb42efd_3043377.png "屏幕截图.png")
- ##### 常用方法及组件封装
    我们封装了一些常用的方法在app/common/controller/ApiCommon.php和app/common/view/common/api_fun.html中，这些方法可以帮助你快速的进行简单的增删改查业务，以及ajax的封装，常用的js验证等；
在app/manager/view/public/vue_template.html中封装了一些常用的组件，包括搜索组件com_search，上传组件com_upload_file，多图上传com_upload_pic等；可以参考系统中是如何使用的；

#### 如果在使用过程中有问题，欢迎您与我们交流。

古红平/PY_API

简介

发行版

贡献者

近期动态

古红平/PY_API .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

古红平/PY_API