Skip to content

基于yii2框架下集成api,管理后台与前台的saas项目

Notifications You must be signed in to change notification settings

h123456j/yii-saas

Repository files navigation

yii-saas

基于yii2框架下使用bootstrap集成api接口,接口在线文档,管理后台与前台的saas项目

目录结构说明

--- assets --资源文件管理器
 --- admin --后台模块资源文件管理
 --- api --api在线文档模块
 --- common --公共资源文件管理
 --- frontend -- 前台模块
--- common --公共代码目录
 --- core --核心公共类
 --- error --错误处理
 --- helpers --帮助类
 --- widgets --组件
--- component --组件模块
 --- controller --基类控制器
 --- exception --异常处理
 --- filter --过滤器
 --- helpers --帮助类
 --- http --网络请求
 --- models --model基类
 --- service --服务基类
 --- session --会话控制
 --- widgets --前台组件
--- config --全局配置模块
 ---admin --管理后台配置
 ---api --api模块配置
 ---frontend --前台配置模块
--- doc --文档相关【sal文件】
--- models -- 数据表models
--- modules -- 模块目录
 --- admin --管理后台
 --- api --接口
 --- doc --在线接口文档
 --- frontend --前台
--- services --服务
--- web  --- static
 --- uploads

前台主页面【页面样式目前没开发,访问地址:{host}】

前台主页

在线接口文档模块【访问地址:{host}/api】

使用php反射API将API模块下控制器与方法的注释生成对应的api文档

在线接口文档主页

在线接口文档主页

控制器层配置模板

<?php
/**
 * Class User
 * @package api\controllers
 * @controller-name 用户模块 --模块名称
 * @controller-rank 20 --模块排序权重【权重越大,在接口文档页面排序越前】
 */
class UserController extends BaseController
{
}
?>

action方法层注释模板

<?php 
 /**
     * @api-name  微信授权登录 --接口名称
     * @api-url user/we-chat-login --接口地址
     * @api-method POST --请求方式
     * @api-param string $code 微信授权登录code --请求参数
     * @api-response {  --返回数据
     *    "data":{
     *      "completeInfo": true,用户信息是否已完善(true-是 false-否)
     *      "uid": "15081455574753",用户id
     *      "sid": "31a569fbbe31a85561f1ede3f6bc750a",会话id
     *        }
     * }
     */
    public function actionWeChatLogin()
    {
    }
?>

接口文档模块会自动渲染api【可通过参数控制】模块下的控制器,遍历各控制器下的方法,实时生成对应的接口文档,生产环境可以将改模块禁止访问

显示效果如下

在线接口文档主页

管理后台模块【访问地址{host}/admin】

管理员登录界面

管理员登录

管理后台主页

管理后台主页

系统设置页面-导航栏

系统设置页面-导航栏

新增导航栏

新增导航栏

文档就描述到这了,欢迎指正,有疑问可以咨询qq:513553191

About

基于yii2框架下集成api,管理后台与前台的saas项目

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published