jlgomes/swapi-php

用于简化使用Starwars(SWAPI) API的项目,可以通过URL或实体+ID进行访问

v1.0.1 2022-10-12 13:47 UTC

This package is auto-updated.

Last update: 2024-09-12 18:53:18 UTC


README

使用选项搜索API数据,可以是正常返回(默认)或对包含URL的属性进行额外搜索。

推荐的PHP版本

  • >=8.0

数据搜索方式

  • url: (https://swapi.dev/api/starships/5)
  • 实体和ID: (starships, 5)

数据返回

  • JSON(默认)
  • 数组

具有额外搜索可能性的URL属性类型

  • homeworld
  • films
  • people
  • planets
  • vehicles
  • species
  • starships
  • characters
  • pilots
  • residents

安装

使用 composer 安装

composer require jlgomes/swapi-php

主要功能

使用示例

通过URL查找数据

  • 参数1(必需):(string) API搜索的URL
  • 参数2(可选,默认false):(bool) 是否对具有URL的属性进行额外搜索。
  • 参数3(可选,默认true):(bool) 是否返回JSON或数组。
  • 使用以下参数将返回Api的简单数据,以JSON格式
use Jlgomes\Swapi\Swapi;

$swapi = new Swapi();
$dataStarships = $swapi->getDataByUrl("https://swapi.dev/api/starships/5");
// Resultado em: https://github.com/jonasbenti/fetch-swapi-data/blob/master/attachment/Sample1.png
echo($dataStarships);

通过实体和ID查找数据

  • 参数1(必需):(string) API搜索的实体
  • 参数2(必需):(int) API搜索的ID
  • 参数3(可选,默认false):(bool) 是否对具有URL的属性进行额外搜索。
  • 参数4(可选,默认true):(bool) 是否返回JSON或数组。
  • 使用以下参数将返回包含额外信息的Api数据,以JSON格式
use Jlgomes\Swapi\Swapi;

$swapi = new Swapi();
$dataPeople = $swapi->getDataByModelAndId('people', 5, true);
// Resultado em: https://github.com/jonasbenti/fetch-swapi-data/blob/master/attachment/Sample2.json
echo($dataPeople);

许可证

MIT License