tobya/bcsapiwrapper

BCS Api 包装器

v4.24 2024-07-22 06:40 UTC

README

BCS API 包装器库 BCSAPI 库 V4

Latest Stable Version Total Downloads Latest Unstable Version License

安装

 composer require tobya/bcsapiwrapper

发布配置文件

php artisan vendor:publish

选择 BCSApiWrapper

.env 文件更新以下值需要在 .env 文件中可用

# Main BCS Api URLS
BCSBACKOFFICE_APIURL=
BCSBACKOFFICE_APIKEY=

# New BCS V4 Api Urls / V3 discontinued
BCSBACKOFFICE_V4_APIURL=
BCSBACKOFFICE_V4_APITOKEN=


# Photo Api
DEMOPHOTO_APIURL=

#Recipe Api
BCSRECIPE_APIURL=
BCSRECIPE_APIKEY=

保持最新状态

composer update

从 V2 升级

您需要在 config/bcsapi.php 中添加以下内容

  'v4' => [
            'backoffice' => [
                'url' => env('BCSBACKOFFICE_V4_APIURL',''),
                'token' => env('BCSBACKOFFICE_V4_APITOKEN',''),
            ],
        ]

并且 .env 文件是

BCSBACKOFFICE_V4_APIURL={base host url, not api.backoffice.ie}
BCSBACKOFFICE_V4_APITOKEN={sanctum token}

V2 BCSApiWrapper

$CourseApi =  App('BCSApi')->Course();
$CourseInfo = $CourseApi->CourseInfo(12345);
echo $CourseInfo->CourseName;

V4 BCSApiWrapper

$CourseApi = BCSLoader::Course();
$CourseInfo = $CourseApi->CourseInfo(12345);
echo $CourseInfo->CourseName;

这可能需要升级时大量代码的重写。

测试

有一个 Postman 收集用于测试主要 BCSApi 路由。

https://github.com/tobya/bcsStudents_gitp4/blob/LaravelSubscriptions/resources/postman/api.cookingisfun.ie%20v2.postman_collection.json