apidoc使用

1.官方文档

2 使用例子

<?php


namespace App\Http\Controllers\Admin\Banner;


use App\Http\Controllers\Controller;
use App\Http\Logic\Admin\Banner\BannerLogic;
use Illuminate\Http\Request;


/**
* @apiDefine banner 通用banner图
*/
class ListController extends Controller
{
    /**
     * @api {get} admin/banner/list 列表(访问方式 + 路由)
     * @apiGroup banner
     * @apiParam {Number} type 类型(必须)
     * @apiParam {Number} [branner_status] 上下架([]代表可选)
     * @apiParam {Number} [page_size]      每页条数
     * @apiParam {Number} [page]           页码
     *
     * @apiSuccess {int}    id                      自增id
     * @apiSuccess {int}    type                    类型
     * @apiSuccess {str}    type_cn                 类型中文
     * @apiSuccess {str}    click_link              跳转url
     * @apiSuccess {array}  banner_image            图片链接
     * @apiSuccess {str}    banner_image.short_url  图片短链接
     * @apiSuccess {str}    banner_image.full_url   图片全链接
     * @apiSuccess {str}    banner_image.thum_url   缩略图链接
     * @apiSuccess {int}    branner_status          上下架状态值
     * @apiSuccess {str}    branner_status_cn       状态中文值
     * @apiSuccess {str}    created_at              创建时间
     *
     * @apiSuccessExample {json} Success-Response:
     * {
     * "code": 200,
     * "msg": "成功",
     * "data": [
     * {
     * "id": 10,
     * "type": 1,
     * "type_cn": "首页顶部",
     * "click_link": "",
     * "banner_image": {
     * "short_url": "1010101010",
     * "full_url": "全链接，直接可以访问到图片",
     * "thum_url": "缩略图链接"
     * },
     * "branner_status": 2,
     * "branner_status_cn": "首页中间",
     * "created_at": "2023-03-29 17:30:41"
     * },
     * {
     * "id": 9,
     * "type": 1,
     * "type_cn": "首页顶部",
     * "click_link": "",
     * "banner_image": {
     * "short_url": "sdfas",
     * "full_url": "全链接，直接可以访问到图片",
     * "thum_url": "缩略图链接"
     * },
     * "branner_status": 1,
     * "branner_status_cn": "首页顶部",
     * "created_at": "2023-03-29 17:30:41"
     * },
     * {
     * "id": 8,
     * "type": 1,
     * "type_cn": "首页顶部",
     * "click_link": "",
     * "banner_image": {
     * "short_url": "222sdafsd",
     * "full_url": "全链接，直接可以访问到图片",
     * "thum_url": "缩略图链接"
     * },
     * "branner_status": 1,
     * "branner_status_cn": "首页顶部",
     * "created_at": "2023-03-29 17:01:34"
     * }
     * ],
     * "page_size": 3,
     * "page": 2,
     * "total": 13
     * }
     *
     */
    public function list(Request $request)
    {
        $params = $request->input();


        $logic = BannerLogic::init();
        return $logic->getlist($params);
    }
}