This API supports full CRUD functionality for an animal shelter database. The database contains a list of all animals at the shelter, with attributes such as species, gender, name, and spayed/neutered status. (For full schema and a sample request body for POST, please refer to the Swagger documentation. Setup instructions for it are below.)

In addition to basic CRUD methods, the API allows:

• Optional query parameters for species and/or gender
• Pagination of data
• Retrieving a randomly selected animal
• Automatic calculation of an animal's Age (in decimal years) when user creates an animal and inputs the Birthdate

• This application requires MySQL.

1. Clone this repository:

   $ git clone https://github.com/schoinh/animal-api.git
   

2. Open the database context file (animal-api/Models/Animal_APIContext.cs) and replace EnvironmentVariables.MySQLKey with a string containing your MySQL password (ex: "abcd123").

3. Log onto MySQL:

   $ mysql -u USERNAME -p PASSWORD
   

4. Navigate to the project directory (Animal-API). Restore dependencies, update your local database, and run the API:

   $ dotnet restore
   $ dotnet ef database update
   $ dotnet run
   

5. The API is now up and running. For full schema and a sample request body for POST, navigate to the Swagger documentation at http://localhost:5001.

http://localhost:5000/api/animals?species=Cat&gender=Male

None at this time.

• C# / .NET Core
• ASP.NET Core MVC
• LINQ
• MySQL
• OpenAPI aka Swagger

Please contact Na Hyung with questions and comments.

GNU GPLv3

Copyright (c) 2019 Na Hyung Choi