An API with pagination. This application allows for a local animal shelter to create and edit animals as needed. Users are able to search for pets in need of a home.
- C#
- ASP.NET Core MVC
- .NET 5.0
- Entity Framework Core
- HTML
- CSS
- Note: An installation of the .NET SDK is required in order to run this application locally. See Here for installation.
-
Clone this repo.
-
Open your shell (e.g., Terminal or GitBash) and navigate to this project's directory called "Factory.Solution/Factory".
-
Create a file named
appsettings.json:$ touch appsettings.json -
Within
appsettings.jsonadd the following code, replacing theuidandpwdvalues with your own username and password for MySQL.{ "ConnectionStrings": { "DefaultConnection": "Server=localhost;Port=3306;database=Benji-database;uid=[YOUR-USERNAME];pwd=[YOUR-MYSQL-PASSWORD];" } } -
Navigate to the project directory:
$ cd Benji -
Run the command dotnet restore to install necessary packages.
-
Run
$ dotnet watch runin the command line to start the project in development mode with a watcher. -
Run the command dotnet build to compile the application.
-
Run dotnet run to start the server and application.
-
Open the browser at: https://localhost:5001. If you cannot access localhost:5001 it is likely because you have not configured a .NET developer security certificate for HTTPS.
-
This application used authentication with Identity. Users must create an account in order to create and edit items.
This document provides detailed descriptions and usage examples for each endpoint in the Benji Application
The base URL for all endpoints is: https://localhost:5001/api/animals
Retrieve a list of animals based on specified filters.
species(string): Filter animals by species.name(string): Filter animals by name.minimumAge(int): Filter animals by minimum age.breed(string): Filter animals by breed.gender(string): Filter animals by gender.adoptionStatus(string): Filter animals by adoption status.
GET /api/animal/{id} Retrieve details of a specific animal by its ID.
https:/localhost:5001/api/animal/1"
{ "animalID: 1 "Species", dog, "name": "Benji", "age": "12, "breed": Poodlelab", "gender": "Male". "adopton status": "available" }
POST /api/animal Add a new animal to the database.
PUT /api/animal/{id} Update information about a specific animal.
DELETE /api/animal/{id} Delete a specific animal by its ID.
Pagination is applied to the list of animals. This enables clients to retrieve a specific subset of animals rather than the entire collection in a single request.
To retrieve a list of animals with pagination, you can make a GET request to the /api/animal endpoint. The following query parameters are available for pagination: example: GET /api/animal?page=2&pageSize=10
The API response includes pagination information: TotalCount of animals in database TotalPages on specified page. CurrentPage PageSize(number of items per page) Animals list for current page
- Please visit this projects GitHub repository to submit Issues and Pull Requests.
MIT License
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.
Copyright (c) Elena Rosa 2023