https://github.com/fauzancodes/yugioh-open-api
The Yu-Gi-Oh! Open API is designed to efficiently and securely support various data management features, including authentication, card database, deck management, and other functionalities to meet player needs.
https://github.com/fauzancodes/yugioh-open-api
api deck-builder golang rest-api yugioh
Last synced: about 1 month ago
JSON representation
The Yu-Gi-Oh! Open API is designed to efficiently and securely support various data management features, including authentication, card database, deck management, and other functionalities to meet player needs.
- Host: GitHub
- URL: https://github.com/fauzancodes/yugioh-open-api
- Owner: fauzancodes
- Created: 2024-11-06T12:31:30.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-01-24T07:25:26.000Z (3 months ago)
- Last Synced: 2025-01-24T08:25:35.954Z (3 months ago)
- Topics: api, deck-builder, golang, rest-api, yugioh
- Language: Go
- Homepage: https://yugioh-open-api.vercel.app
- Size: 4.54 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Yu-Gi-Oh! Open API Documentation
Welcome to the **Yu-Gi-Oh! Open API** documentation. This API is built using the [Go](https://go.dev/) programming language with the [Echo](https://echo.labstack.com/) framework, leveraging [GORM](https://gorm.io/) as the ORM for database connections. [PostgreSQL](https://www.postgresql.org/) is used as the main database, ensuring high performance and scalability. The API is designed to efficiently and securely support various data management features, including authentication, card database, deck management, and other functionalities to meet player needs.
## Features
- **Secure Authentication**:
Effortless user access with login and register endpoints, powered by [JWT](https://jwt.io/) authentication and industry-standard [bcrypt](https://en.wikipedia.org/wiki/Bcrypt) hashing for a secure user experience.
- **Dynamic Card Database**:
Access the comprehensive Yu-Gi-Oh! card database through public endpoints featuring advanced filtering, searching, and sorting options to explore cards effortlessly.
- **Personalized Deck Builder**:
Build your dream decks with endpoints that support creating, updating, and deleting custom decks, empowering users to manage their strategies effectively.
- **Public Deck Sharing**:
Discover community-created decks through public deck endpoints, featuring filtering by user preferences.
- **Dynamic Data Retrieval**:
All GET endpoints feature dynamic pagination, filtering, searching, and sorting options, making data retrieval intuitive and efficient.
- **Robust Input Validation**:
Ensure data integrity with comprehensive validation on all POST endpoints, preventing errors and enhancing user experience.
- **SQL Injection Prevention**:
All endpoints are protected with query parameter sanitization, guarding against SQL injection attacks for enhanced security.
- **Secure API Key**:
Each request to the endpoints is protected with an API key generated using [HMAC](https://en.wikipedia.org/wiki/HMAC) and [SHA-256](https://en.wikipedia.org/wiki/SHA-2) methods, ensuring robust security and integrity for every transaction while safeguarding your data from unauthorized access.
- **Comprehensive Documentation**:
Navigate through the API with ease using clear, organized [Postman](https://www.postman.com/) documentation designed to ensure a smooth development experience for all developers.
## How to Use?
- Register via endpoint, `POST /v1/auth/register`
- Create API Key via endpoint, `POST /v1/auth/generate-api-key`
- Calculate the HMAC signature between the `public_key` and the `secret_key` using SHA-256.
- The result of the HMAC calculation is combined with the `public_key` with the pattern `public_key:hmac_result`.
- Then, encode the pattern with the Base64 algorithm, put the endcode result in the request header as `X-Api-key`.
---
© 2024 Yu-Gi-Oh! Open API Project. All rights reserved. By [fauzancodes](https://fauzancodes.id/).