https://github.com/Blagues-API/blagues-api-php

😂 Module PHP officiel de Blagues-API
https://github.com/Blagues-API/blagues-api-php

blagues-api php

Last synced: 6 days ago
JSON representation

😂 Module PHP officiel de Blagues-API

• Host: GitHub
• URL: https://github.com/Blagues-API/blagues-api-php
• Owner: Blagues-API
• License: mit
• Created: 2022-04-27T14:37:21.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-27T19:30:36.000Z (about 1 year ago)
• Last Synced: 2024-09-26T23:41:15.622Z (about 2 months ago)
• Topics: blagues-api, php
• Language: PHP
• Homepage: https://packagist.org/packages/zuruuh/blagues-api
• Size: 55.7 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Blagues API

Blagues API est un api public, français, et Open-Source, qui permet a n'importe qui d'accéder et de contribuer à une vaste collections de blagues en tous genres. Ce paquet packagist permet à n'importe qui d'intéragir avec l'api très simplement en php avec une approche orientée objet.

## Authentification

Vous pouvez récupérer votre token d'authentification sur le site officiel https://www.blagues-api.fr en cliquant sur le bouton "Connexion"

## Exemples

**Voici quelques exemples simples de comment vous pouvez intéragir avec l'api.**

```php

getRandom(); // Renvoies une instance de la classe BlaguesApi\Model\Joke

var_dump($joke->getJoke()); // Renvoie le contenu de la blague.

var_dump($joke->getAnswer()); // Renvoie la réponse à la blague si il y en a une.

```

```php

getById(1234);

dump($joke->getId()); // renvoies 1234

$joke = $blaguesApi->getRandom([Joke::TYPE_DARK]); // Récuperes une blague aléatoire de n'importe quel type excepté `Joke::TYPE_DARK`.

$joke = $blaguesApi->getByType(Joke::TYPE_DEV); // Récuperes une blague aléatoire de type `Joke::TYPE_DEV`.

```

Exemple avec Symfony

```php

getRandom();

        return $this->render('template/joke.html.twig', [

            'joke' => $joke,

        ]);

    }

}

```

Exemple Symfony avec injection de dépendance + factory

```yaml

# config/services.yaml

services:

  BlaguesApi\BlaguesApiInterface:

    factory: ['BlaguesApi\BlaguesApiFactory', create]

    arguments: ['%env(BLAGUES_API_TOKEN)%']

```

```php

getRandom();

        return $this->render('template/joke.html.twig', [

            'joke' => $joke,

        ]);

    }

}

```

## Contributions

Pour contribuer au projet, merci de jeter un oeil à [contributing.md](./contributing.md).