josmlt / spoonacular-laravel-wrapper
Spoonacular API 的 Laravel 包装器
Requires
- php: ^7.3|^8.0
- guzzlehttp/guzzle: ^7.0.1
- illuminate/support: ^8.50
Requires (Dev)
- orchestra/testbench: ^6.0
- phpunit/phpunit: ^9.5
README
Spoonacular Laravel 包装器
什么是 📝
这是一个使用 Facades 从 Spoonacular API 请求资源(如食谱、随机食谱、营养成分等)的软件包,并提供了不同的排序选项,如卡路里、过敏原等。
目的
这是为了学习 Facades 和 Laravel 软件包的工作原理。
安装步骤 ℹ️
需要在 Spoonacular 上注册并获得一个 API 密钥。
本地开发包 ℹ️
我们需要创建一个文件夹,在它内部创建一个 Laravel 项目并克隆仓库。结构类似于以下:
-- foo
-- laravel_project
-- package_laravel
之后,打开我们的主 Laravel 项目的 composer.json 文件,添加以下属性:
"require": {
[. . .]
"josmlt/spoonacular-laravel-wrapper": "dev-master",
}
"repositories": [
{
"type": "path",
"url": "../spoon-wrapper"
}
],
下一步是要求将软件包添加到我们的项目中,执行:
composer require josmlt/spoonacular-laravel-wrapper
我们将看到以下消息:安装 josmlt/spoonacular-laravel-wrapper (dev-master): 从 ../spoon-wrapper 联结
然后执行以下命令,它会发布配置文件:
php artisan vendor:publish --tag=spoonacular
最后,我们有两个选择,首先我们可以在 config/spoonacular.php 中设置 SPOONACULAR_API_KEY 的默认值,或者我们也可以在我们的 .env 中添加一个新的环境变量,例如 SPOONACULAR_API_KEY = ""
从 Packagist ℹ️
我们需要从 Packagist 将软件包拉取到我们的 Laravel 项目中。
composer require josmlt/spoonacular-laravel-wrapper
正确安装后,我们需要发布一个自定义配置文件,执行:
php artisan vendor:publish
最后,我们进入:
config/spoonacular.php
并添加我们从 Spoonacular 获取的 API 密钥,或者您可以创建一个名为 SPOONACULAR_API_KEY 的新环境变量。
如何使用它 ❓
👉 如果我们想获取含有番茄的食谱,例如,我们只需要用这个关键词搜索食谱,输入:
Spoonacular::searchRecipes('tomato');
👉 但还有其他什么?如果您需要进行复杂搜索,例如您对鸡蛋过敏或您想按卡路里数量排序结果...输入:
Spoonacular::searchRecipes(
[
'query' => 'tomato',
'intolerances' => 'egg',
'sort' => 'calories'
]
);
👉 或者获取随机食谱
Spoonacular::getRandomRecipes();
测试 ✔️
此软件包提供了一些测试,目的是使用户对软件包更加自信,并检查是否可以在不破坏任何有价值的东西的情况下添加新功能。
在包内执行以下命令: vendor/bin/phpunit tests/Unit/SpoonacularFacadeTest.php
下载或克隆项目后,别忘了执行 composer install,还需要获取一个有效的API密钥。