ygo-skc/skc-api

API to use to access info on individual YGO; cards, ban lists, and products.

README

Supreme Kings Castle (SKC)

SKC is the best YuGiOh database. It offers players a fast and free interface to find cards, products, and ban list information.

This GitHub Repo contains the API portion of SKC. It is used by the website to interface with the Database.

Note: A Suggestion Engine is being built and will be a new API. Links will be provided later :)

"Hey Can I Use Your API For...?"

Short answer - maybe.

I understand that developers who are starting out with Web API's can struggle a bit. As such, any developer who is just learning about REST can use my API to get a feel for the spec.

Teachers and/or instructors can also use the API for demonstration.

However, since it takes time to build a robust Database from scratch alone in a room, usage of the API is not allowed for commercial use.

Essentially, if you want to learn about computers/CS/coding/etc. and need random data/ random service to call, use the API! If you want to make money, build your own. I cannot afford to offset other people's traffic on my servers :(

Contributions

Developers

Developers can help by creating Git Issues on bugs/feature requests/etc.

Currently, I do not need extra hands and have no way of paying people. Making it a full open source project is also something I do not plan on doing because it can quickly deter from my vision.

The Source code is public so other developers can critique it.

Others

This is an unfunded project. In other words, there is no Crowd Funding offering you perks in vain attempt to take your money.

This means that everything is coming out of my pocket. There are ways of donating via PayPal/BTC BUT that should only be done by users who use the service frequently AND find value in it. There are no perks in donating. You will also have to find how to donate on your own.

I am also offering the community more content. Check out the links for my YouTube channel and subscribe to support the project by watching my videos.

In summary, I am trying to provide a free, non-add supported, fast and clean service for everyone I am finding unconventional ways of funding it. Along the way, I am providing not only the service, but entertainment. Now how many "Yugi Tubers" can say that?

Links

• Website
• API Functionality
• YouTube

skc-api's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

---

Warning

Renovate failed to look up the following dependencies: Failed to look up maven package kotlin.jvm.internal:org.springframework.util.StopWatch.

Files affected: build.gradle.kts

---

This repository currently has no open or pending branches.

Detected dependencies

docker-compose

docker-compose-local.yml

• eclipse-temurin 21.0.3_9-jre-alpine

docker-compose.yml

• eclipse-temurin 21.0.3_9-jre-alpine

github-actions

.github/workflows/build.yaml

• actions/checkout v4.1.7
• actions/setup-java v4.2.1
• gradle/gradle-build-action v3.4.2
• actions/upload-artifact v4.3.3

gradle

gradle.properties

settings.gradle.kts

build.gradle.kts

• org.springframework.boot 3.3.1
• io.spring.dependency-management 1.1.5
• info.solidsoft.pitest 1.15.0
• com.adarshr.test-logger 4.0.0
• org.jetbrains.kotlin.jvm 2.0.0
• org.jetbrains.kotlin.plugin.spring 2.0.0
• org.springframework.boot:spring-boot-starter-webflux 3.3.1
• org.springframework.boot:spring-boot-starter-hateoas 3.3.1
• org.springframework.boot:spring-boot-starter-data-jpa 3.3.1
• org.springframework.boot:spring-boot-starter-validation 3.3.1
• org.springframework.boot:spring-boot-starter-log4j2 3.3.1
• jakarta.servlet:jakarta.servlet-api 6.1.0
• org.springdoc:springdoc-openapi-starter-webmvc-ui 2.6.0
• org.slf4j:slf4j-api 2.0.13
• mysql:mysql-connector-java 8.0.33
• com.fasterxml.jackson.core:jackson-core 2.17.1
• com.fasterxml.jackson.module:jackson-module-kotlin 2.17.1
• org.yaml:snakeyaml 2.2
• org.jetbrains.kotlinx:kotlinx-coroutines-core 1.8.1
• org.jetbrains.kotlinx:kotlinx-coroutines-reactor 1.8.1
• com.google.guava:guava 33.2.1-jre
• kotlin.jvm.internal:org.springframework.util.StopWatch org.slf4j.Logger
• jacoco 0.8.12

gradle/integTest.gradle.kts

• commons-logging:commons-logging 1.3.2
• io.cucumber:cucumber-java 7.18.0
• io.rest-assured:rest-assured 5.4.0
• io.rest-assured:json-path 5.4.0
• io.rest-assured:xml-path 5.4.0
• org.apache.groovy:groovy 4.0.22
• org.apache.groovy:groovy-xml 4.0.22

gradle/perfTest.gradle.kts

• io.gatling.highcharts:gatling-charts-highcharts 3.11.5
• io.gatling:gatling-core 3.11.5
• org.scala-lang:scala-library 2.13.14

gradle/unitTest.gradle.kts

• com.nhaarman:mockito-kotlin 1.6.0
• org.springframework.boot:spring-boot-starter-test 3.3.1
• io.projectreactor:reactor-test 3.6.7
• com.h2database:h2 2.2.224

gradle-wrapper

gradle/wrapper/gradle-wrapper.properties

• gradle 8.8

---

• Check this box to trigger a request for Renovate to run again on this repository

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

Enhancement - Improve Queries

Enhancement

Improve response times by optimizing queries.

Description

The whole point of the API is to retrieve data from a database. Queries should be as optimized as possible to minimize response times.

Research

• MATCH/FULLTEXT MySQL feature

Update health check endpoint in EC2 with new Status endpoint

Old Endpoint: /api/v1/testcall

New Endpoint: /api/v1/status

This will be when v1.3.0 is uploaded to server

Enhancement - Java 2 Kotlin

Enhancement

Migrate from Java to Kotlin. The main src folder should use the Kotlin language.

Description

Use the latest version of Kotlin so coding is fun and rewarding.

Bug Report -

Describe the bug

Product details (cards in product) is no longer in pack order.

REST request used that produced bug

REST Method, eg) GET, POST, etc: GET

Full URL (with url params & endpoint) used: api/v1/product/GRCR/en

Request body: N/A

Request headers: N/A

Website issue

Can you see the issue in the website (https://www.thesupremekingscastle.com)?: Yah

If so, attach a screenshot or url for page that sees issue and briefly describe where to look:

Enhancement - Make Ban List Diff DB Calls Async

Enhancement

Just like in BanService, make these calls Async for both regular and Duel Link type formats.

Description

To improve performance, make calls Async and return to consumer ASAP.