https://github.com/ikoene/marvel-api-bundle

A Symfony bundle that provides a Marvel API client service.
https://github.com/ikoene/marvel-api-bundle

symfony symfony-bundle

Last synced: about 1 month ago
JSON representation

A Symfony bundle that provides a Marvel API client service.

• Host: GitHub
• URL: https://github.com/ikoene/marvel-api-bundle
• Owner: ikoene
• License: mit
• Created: 2018-02-16T20:50:06.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-03-05T19:57:09.000Z (almost 7 years ago)
• Last Synced: 2024-12-01T14:47:35.770Z (about 1 month ago)
• Topics: symfony, symfony-bundle
• Language: PHP
• Size: 48.8 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/ikoene/marvel-api-bundle.svg?branch=master)](https://travis-ci.org/ikoene/marvel-api-bundle)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/ikoene/marvel-api-bundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/ikoene/marvel-api-bundle/?branch=master)

[![Packagist](https://img.shields.io/packagist/v/ikoene/marvel-api-bundle.svg)](https://packagist.org/packages/ikoene/marvel-api-bundle)

[![Installs](https://img.shields.io/packagist/dt/ikoene/marvel-api-bundle.svg)](https://packagist.org/packages/ikoene/marvel-api-bundle)

[![license](https://img.shields.io/github/license/ikoene/marvel-api-bundle.svg?maxAge=2592000)](https://github.com/ikoene/Marvel-API-bundle/blob/master/LICENSE)

# Marvel API bundle

The **Marvel Comics API** allows developers everywhere to access information about Marvel's vast library of comics—from what's coming up, to 70 years ago. This **Marvel API bundle** helps you explore the Marvel universe with great ease.

## Requirements

* PHP 7.1.0

* [Marvel API key](http://developer.marvel.com/account)

* Love for Marvel

## Installation

Applications that use Symfony Flex

----------------------------------

Open a command console, enter your project directory and execute:

```console

$ composer require ikoene/marvel-api-bundle

```

Applications that don't use Symfony Flex

----------------------------------------

### Step 1: Download the Bundle

Open a command console, enter your project directory and execute the

following command to download the latest stable version of this bundle:

```console

$ composer require ikoene/marvel-api-bundle

```

This command requires you to have Composer installed globally, as explained

in the [installation chapter](https://getcomposer.org/doc/00-intro.md)

of the Composer documentation.

### Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles

in the `app/AppKernel.php` file of your project:

```php

get('ikoene_marvel_api_client');

$response = $client->getCharacter(1009610);

var_dump($response);

```

### Endpoints

You can call every endpoint with an explicitly defined method. So if you, for example, want a list of comics containing a specific character, you can call `getComicsForCharacter()`.

```

$response = $client->getComicsForCharacter(1009610);

```

### Optional filters

It's also possible to add optional filters to the calls. Let's get all comics for 'Spider-Man' which title starts with 'Age of Ultron' and order the results by 'title'.

```

$comicFilter = new Ikoene\MarvelApiBundle\Entity\ComicFilter();

$comicFilter->setTitleStartsWith('Age of Ultron');

$comicFilter->setOrderBy('title');

$response = $client->getComicsForCharacter(1009610, $comicFilter);

```

Pretty easy, right?

## Additional info

* [Marvel API documentation](http://developer.marvel.com/docs)

* [Marvel API terms of use](http://developer.marvel.com/terms)