Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hafizn07/epic-rpg-api
This repository houses the Epic-RPG Backend API, a feature-rich web API built with .NET 7 and C#. It powers the Epic-RPG game, allowing users to manage characters, skills, weapons, and engage in epic battles. Explore a robust set of endpoints for game management.
https://github.com/hafizn07/epic-rpg-api
backend-api csharp dotnet7 rpg-game webapi
Last synced: about 9 hours ago
JSON representation
This repository houses the Epic-RPG Backend API, a feature-rich web API built with .NET 7 and C#. It powers the Epic-RPG game, allowing users to manage characters, skills, weapons, and engage in epic battles. Explore a robust set of endpoints for game management.
- Host: GitHub
- URL: https://github.com/hafizn07/epic-rpg-api
- Owner: hafizn07
- Created: 2023-10-30T14:18:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-07T14:59:26.000Z (about 1 year ago)
- Last Synced: 2023-12-02T15:35:49.292Z (12 months ago)
- Topics: backend-api, csharp, dotnet7, rpg-game, webapi
- Language: C#
- Homepage:
- Size: 67.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Epic-RPG Backend API Documentation
Welcome to the Epic-RPG Backend API documentation. This API is the backbone of an RPG game and allows you to perform various actions and interactions within the game.
## Table of Contents
1. [Introduction](#introduction)
2. [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
3. [Endpoints](#endpoints)
- [Authentication](#authentication)
- [Character Management](#character-management)
- [Fight](#fight)
- [Weapon](#weapon)
4. [Database](#database)
- [Entities and Relationships](#entities-and-relationships)
- [Data Seeding](#data-seeding)
5. [Authentication and Authorization](#authentication-and-authorization)
- [JSON Web Tokens (JWT)](#json-web-tokens-jwt)
- [User Registration](#user-registration)
- [User Login](#user-login)
6. [Project Structure](#project-structure)
- [Solution Overview](#solution-overview)
- [Commit History](#commit-history)
7. [Contributing](#contributing)
## Introduction
The Epic-RPG Backend API is built using .NET 7 and C# Web API. It provides the functionality for managing user accounts, character creation and management, skills, weapons, and combat in the Epic-RPG game.
## Getting Started
### Prerequisites
- .NET 7
- Entity Framework
- SQL Server or other compatible database
- Git
### Installation
1. Clone the repository:
```bash
git clone https://github.com/hafizmp/Epic-RPG-API.git
```
2. Navigate to the project directory and set up the database connection string.
3. Run the following command to create the database and apply migrations:
```bash
dotnet ef database update
```
4. Start the API:
```bash
dotnet watch run
```
The API will be accessible at `http://localhost:5200/`
## Endpoints
### Authentication
- __POST__ `/api/Auth/Register` : User registration.
- __POST__ `/api/Auth/Login` : User login to obtain a JWT token.
### Character Management
- __GET__ `/api/Character/GetAll` : Get all characters.
- __GET__ `/api/Character/{id}` : Get a specific character.
- __DELETE__ `/api/Character/{id}` : Delete a specific character.
- __POST__ `/api/Character` : Create a new character.
- __PUT__ `/api/Character` : Update a character.
- __POST__ `/api/Character/Skill` : Manage skills for a character.
### Fight
- __POST__ `/api/Fight/Weapon` : Use a weapon during a fight.
- __POST__ `/api/Fight/Skill` : Use a skill during a fight.
- __POST__ `/api/Fight` : Begin a fight.
- __GET__ `/api/Fight` : Get information about an ongoing fight.
### Weapon
- __POST__ `/api/Weapon` : Create a new weapon.
## Database
### Entities and Relationships
The API uses Entity Framework to manage the following entities and their relationships:
- Users
- Characters
- Skills
- Weapons
### Data Seeding
The database is seeded with initial data to demonstrate the API's functionality.
## Authentication and Authorization
### JSON Web Tokens (JWT)
This API uses JWT for authentication and authorization.
### User Registration
Users can register using the `/api/Auth/Register` endpoint.
### User Login
Users can obtain an access token by logging in via the `/api/Auth/Login` endpoint.
## Project Structure
### Solution Overview
- `EpicRPG.API` : The main API project.
- `EpicRPG.Data` : Data models and Entity Framework setup.
- `EpicRPG.Services` : Business logic and services.
- `EpicRPG.Auth` : Authentication services.
- `EpicRPG.DTOs` : Data transfer objects.
- `EpicRPG.Controllers` : API controllers.
## Commit History
Here are some of the key commits that contributed to the development of the API:
- Find commits by clicking here - [Epic-RPG-API commits](https://github.com/hafizmp/Epic-RPG-API/commits/main)
## Contributing
Feel free to contribute to the development of Epic-RPG-API by submitting pull requests or reporting issues.