jlgomes/swapi-php

Projeto utilizado para simplificar a utilização da API do Starwars(SWAPI), utilizando pela url ou entidade+id

Maintainers

Details

github.com/jonasbenti/fetch-swapi-data

Source

Issues

Installs: 0

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 0

Open Issues: 0

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

Requires

MIT db460f6aa43bf89814a65126018be105b75dcc4a

httpresthttp clientclientswapi

This package is auto-updated.

Last update: 2024-04-12 17:37:37 UTC

README

Busca os dados na api com a opção do retorno normal(default) ou com busca adicional nos atributos que pussem uma url.

Versão recomendada do PHP:

  • >=8.0

Forma de buscar os dados

  • url: (https://swapi.dev/api/starships/5)
  • entidade e id: (starships, 5)

Retorno dos dados

  • JSON (default)
  • ARRAY

Tipo de atributos com url que possuem a possibilidade de busca adicional

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

Installation

Instalar com composer

composer require jlgomes/swapi-php

Funções Principais

Exemplos de utilização

Buscar dados pela url:

  • parâmetro 1(obrigatório): (string) url para realizar a busca na API
  • parâmetro 2(opcional default false): (bool) informa se deve ser realizada a busca adicional nos atributos com url.
  • parâmetro 3(opcional default true): (bool) informa se deve retornar um Json ou um Array
  • Com os parâmetros utilizados abaixo serão retornados os dados simples da Api em 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);

Buscar dados pela entidade e id:

  • parâmetro 1(obrigatório): (string) entidade para realizar a busca na API
  • parâmetro 2(obrigatório): (int) id para realizar a busca na API
  • parâmetro 3(opcional default false): (bool) informa se deve ser realizada a busca adicional nos atributos com url.
  • parâmetro 4(opcional default true): (bool) informa se deve retornar um Json ou um Array
  • Com os parâmetros utilizados abaixo serão retornados os dados com informações adiconais da Api em 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);

Licence

MIT License