Cretaceous API

By Seth Gonzales

A C# / ASP.NET Core MVC application using Entity Framework Core and MySQL.

Technologies Used

C#
.NET 6
ASP.NET Core MVC
Entity Framework Core
Postman v10.19
MySQL
MySQL Workbench

Description

This is a Web API application that shares and stores data regarding animals of the Cretaceous Period. Following full CRUD functionality, users can access the data, update animals, delete animals, and create new animals. This API utilizes pagination to limit the number of results given at a time when a user makes a request to see a list of all animals.

Setup and Installation Requirements

Required Technology

Before starting, check that all required technologies are used. For more information on configuring MySQL and MySQLWorkbench, follow the links provided.

Launching and Setting Up the Project

Navigate to the Cretaceous Api repository GitHub.
Clone the repository down using $ git clone https://github.com/sethgonzales/CretaceousApi.Solution.git in your terminal.
Within the production directory CretaceousApi, create a new file called appsettings.json.
Within appsettings.json, put in the following code, replacing the database, uid, and pwd values with your own database name, username, and password for MySQL.

{
  "Logging": {
      "LogLevel": {
      "Default": "Warning"
      }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
      "DefaultConnection": "Server=localhost;Port=3306;database=YOUR_DATABASE;uid=YOUR_USERNAME;pwd=YOUR_PASSWORD;"
  }
}

Setting up the database

If not already configured, install the Entity Framework Core tool dotnet-ef using the command $ dotnet tool install --global dotnet-ef --version 6.0.0 in your terminal. This will allow for data migrations and updates to the project's database.

Running the project

Navigate to this project's production directory CretaceousApi.
Recreate the database by running the command $ dotnet ef database update in your terminal.
Navigate to your MySQLWorkbench to double check that your database has been built without error.
In the command line, run the command $ dotnet run or $ dotnet watch run to compile and execute the application.
- To compile the application without running it, use the following command: $ dotnet build.

API Documentation

Explore API endpoints in your browser or in Postman.

Note on Pagination

The Cretaceous API defaults to 10 items per page, beginning on page number 1. To change the number of items (pageSize), or the starting page number (pageIndex), you can edit the search parameters following the example below.

Cretaceous Animal API Endpoints

Base URL: http://localhost:5000

Request Type	Path
GET	/api/animals/
GET	/api/animals/{id}
POST	/api/animals/
PUT	/api/animals/{id}
DELETE	/api/animals/{id}

Path Parameters

Parameter	Type	Default	Required	Description
pageIndex	Number	1	not required	Returns the requested index page.
pageSize	Number	10	not required	Returns up to the requested number of animals per page.
name	String	none	not required	Return animals matching requested name.
species	String	none	not required	Return animals matching requested species
minumumAge	Number	none	not required	Returns animals with an age value that is greater than or equal to the specified minimumAge number.

Example Queries

This query will return the first page containing up to 10 animals.

http://localhost:5000/api/Animals

This query will also return the first page containing up to 10 animals.

http://localhost:5000/api/Animals?pageIndex=1&pageSize=10

This query will return the first page containing up to 10 animals of the species Dinosaur.

http://localhost:5000/api/Animals?species=Dinosaur&pageIndex=1&pageSize=10

This query will return the first page containing up to 10 animals of the name Matilda.

http://localhost:5000/api/Animals?name=Matilda&pageIndex=1&pageSize=10

This query will return the first page containing up to 10 animals of an age greater than or equal to 2.

http://localhost:5000/api/Animals?minimumAge=2&pageIndex=1&pageSize=10

This query will return the first page containing up to 10 animals of the species Dinosaur, name Matilda, and minimum age of 2.

http://localhost:5000/api/Animals?species=Dinosaur&name=Matilda&minimumAge=2&pageIndex=1&pageSize=10

Example JSON Response

[
  {
    "animalId": 3,
    "name": "Matilda",
    "species": "Dinosaur",
    "age": 2
  }
]

Known Bugs

There are no known bugs for this API. If you find any, please report them to sethgonzales157@gmail.com

MIT License

Copyright (c) 2023 Seth Gonzales

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Contact Information

If you run into any issues, or would like to contribute to our code, please email: sethgonzales157@gmail.com.

Return to Top

sethgonzales / CretaceousApi.Solution