ShakespeareanPokemon

A simple RESTful API for getting a pokemon with its shakespearean description, it's built on .NET 6 and utilies two RESTful APIs:

1. RESTful Pokémon API - https://pokeapi.co/
2. Shakespeare translator API - https://funtranslations.com/api/shakespeare

Requirements:

1. .NET 6

How to run:

1. Clone the repo.
2. Go to this path ShakespeareanPokemon\ShakespeareanPokemon.Api and run this command dotnet run
3. The API will be up and running after this locally on port 7060 you can use this path in the browser: https://localhost:7060/swagger/index.html

Try the API:

The API contains one endpoint which recieves a pokemon name, and returns the pokemon name and the shakespearean translation for it. to try the API.

1. Go to https://localhost:7060/swagger/index.html.
2. Click on try it out
3. Pass a pokemon name, for example: wormadam
4. Press Execute
5. A reponse will be sent back: { "result": { "name": "wormadam", "description": "Forms hath't different stats and movepools. During evolution, burmy's current cloak becomes wormadam's form, and can nay longer beest did doth change." }, "success": true, "errors": null }

Unit testing

To run the unit tests for this project you can run it directly from VS or Rider, or you can navigate to this path: ShakespeareanPokemon\ShakespeareanPokemon.Service.UnitTests and run this command dotnet test

Integration testing

To run the integration tests for this project you can run it directly from VS or Rider, or you can navigate to this path: ShakespeareanPokemon\ShakespeareanPokemon.Service.IntegrationTests and run this command dotnet test

• Be careful of running it too many times, because the translation API may return StatusCode: 429, ReasonPhrase: 'Too Many Requests', in this case the description will be null.

Docker

To run the API as a containerized image:

1. Go to ShakespeareanPokemon directory
2. Run docker build -t poke-image -f Dockerfile .
3. Run docker run --name poke-image -p 8081:80 -d poke-image
4. In the browser go to http://localhost:8081/swagger/

Nuget Packages used:

• xunit 2.4.1
• Moq 4.17.2
• Serilog.AspNetCore 5.0.0
• NSwag.AspNetCore 13.15.10

What needs to be fixed

1. Better Logging needs to be done.
2. Better Exception handling and error specification.
3. Docker image size to be reduced.