feat: Add openapi explorer

Signed-off-by: Avior <git@avior.me>

CONTRIBUTING.md

@@ -1,5 +1,4 @@
 <!-- omit in toc -->
-
 # Contributing to TCGdex
 
 First off, thanks for taking the time to contribute! ❤️
@@ -7,26 +6,23 @@ First off, thanks for taking the time to contribute! ❤️
 All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
 
 > And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
-> 
 > - Star the project
 > - Tweet about it
 > - Refer this project in your project's readme
 > - Mention the project at local meetups and tell your friends/colleagues
 
 <!-- omit in toc -->
-
 ## Table of Contents
 
 - [Code of Conduct](#code-of-conduct)
 - [I Have a Question](#i-have-a-question)
 - [I Want To Contribute](#i-want-to-contribute)
-  - [Reporting Issues](#reporting-issues)
+- [Reporting Bugs](#reporting-bugs)
-  - [Suggesting Enhancements](#suggesting-enhancements)
+- [Suggesting Enhancements](#suggesting-enhancements)
-  - [Your First Code Contribution](#your-first-code-contribution)
+- [Your First Code Contribution](#your-first-code-contribution)
-  - [Improving The Documentation](#improving-the-documentation)
+- [Improving The Documentation](#improving-the-documentation)
 - [Styleguides](#styleguides)
-  - [Coding Guidlines](#coding-guidelines)
+- [Commit Messages](#commit-messages)
-  - [Commit Messages](#commit-messages)
 - [Join The Project Team](#join-the-project-team)
 
 ## Code of Conduct
@@ -37,7 +33,7 @@ By participating, you are expected to uphold this code. Please report unacceptab
 
 ## I Have a Question
 
-> If you want to ask a question, we assume that you have read the available Documentation at <https://www.tcgdex.dev>.
+> If you want to ask a question, we assume that you have read the available [Documentation](https://tcgdex.dev).
 
 The best way to ask questions is to join our Discord server at <https://discord.gg/NehYTAhsZE>.
 
@@ -69,38 +65,36 @@ Depending on how large the project is, you may want to outsource the questioning
 ## I Want To Contribute
 
 > ### Legal Notice <!-- omit in toc -->
-> 
+> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.
-> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
 
-### Reporting Issues
+### Reporting Bugs
 
 <!-- omit in toc -->
+#### Before Submitting a Bug Report
 
-#### Before Submitting an Issue Report
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
 
-A good issue report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+- Make sure that you are using the latest version.
-
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://tcgdex.dev). If you are looking for support, you might want to check [this section](#i-have-a-question)).
-- Determine if your issue is not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://www.tcgdex.dev). If you are looking for support, you might want to check [this section](#i-have-a-question)).
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https:/github.com/tcgdex/cards-database/issues?q=label%3Abug).
-- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already an issue report existing for your bug or error in the [bug tracker](https://github.com/tcgdex/cards-database/issues).
 - Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
 - Collect information about the bug:
-  - Stack trace (Traceback)
+- Stack trace (Traceback)
-  - OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
-  - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
+- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
-  - Possibly your input and the output
+- Possibly your input and the output
-  - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
 
 <!-- omit in toc -->
-
 #### How Do I Submit a Good Bug Report?
 
-> You must never report security related issues, vulnerabilities or bugs to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <security@tcgdex.net>.
+> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <security@tcgdex.net>.
 
 <!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
 
 We use GitHub issues to track bugs and errors. If you run into an issue with the project:
 
-- Open an [Issue](https://github.com/tcgdex/cards-databaseissues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+- Open an [Issue](https://github.com/tcgdex/cards-database/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
 - Explain the behavior you would expect and the actual behavior.
 - Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
 - Provide the information you collected in the previous section.
@@ -122,20 +116,19 @@ This section guides you through submitting an enhancement suggestion for TCGdex,
 #### Before Submitting an Enhancement
 
 - Make sure that you are using the latest version.
-- Read the [documentation](https://www.tcgdex.dev) carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Read the [documentation](https://tcgdex.dev) carefully and find out if the functionality is already covered, maybe by an individual configuration.
-- Perform a [search](https://github.com/tcgdex/cards-databaseissues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Perform a [search](https://github.com/tcgdex/cards-database/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
 - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
 
 <!-- omit in toc -->
-
 #### How Do I Submit a Good Enhancement Suggestion?
 
-Enhancement suggestions are tracked as [GitHub issues](https://github.com/tcgdex/cards-databaseissues).
+Enhancement suggestions are tracked as [GitHub issues](https:/github.com/tcgdex/cards-database/issues).
 
 - Use a **clear and descriptive title** for the issue to identify the suggestion.
 - Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
 - **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
-- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
+- You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and the built-in [screen recorder in GNOME](https://help.gnome.org/users/gnome-help/stable/screen-shot-record.html.en) or [SimpleScreenRecorder](https://github.com/MaartenBaert/ssr) on Linux. <!-- this should only be included if the project has a GUI -->
 - **Explain why this enhancement would be useful** to most TCGdex users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
 
 <!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
@@ -150,6 +143,11 @@ _note: Follow the different styleguides listed below when contributing_
 - we don't like ❌, so if your pull request has its automated checks ending with the red cross, please double check your changes until it show the awesome 🟢, or ask for help !
 - If your pull request is ready for review remove WIP: put it s ready for review and we will handle the rest !
 
+folders :
+- `data`: the database for the internationnal cards
+- `data-asia`: the database for the asian cards
+- `server`: The server behind the API
+
 ### Improving The Documentation
 
 The documentation is updated in the Documentation repository at <https://github.com/tcgdex/documentation>
@@ -160,8 +158,8 @@ The documentation is updated in the Documentation repository at <https://github.
 
 Install the plugin `.editorconfig` in your dev environment if it's not already done and thats it !
 
-for those who don't want to install it the basic are these:
+for those who don't want to install it, the basics are these:
-- Indent using the `tab` or `\t` character
+- Indent using the <xkb>tab</xkb> (`\t`) character
 - the line feed character is `\n`
 - only use `;` when necessary and at the start of the line
 - use double quotes `"` when editing files in the `data/` folder and single quote `'` in other files
@@ -195,6 +193,6 @@ In short, please name your Pull Requests/Commits following this format
   -  use the imperative, present tense: "Change" not "Changed" nor "Changes"
 - `<footer>` and `<body>` are both optional
 
+<!-- omit in toc -->
 ## Attribution
-
+This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!
-This guide is based on [Contribution Gen]((https://github.com/bttger/contributing-gen)) and was adapted by the TCGdex community !

meta/definitions/openapi.yaml

@@ -636,6 +636,7 @@ components:
       type: object
       properties:
         id:
+          description: test
           type: string
         name:
           type: string
@@ -701,6 +702,7 @@ components:
           example: base1
         name:
           type: string
+
           example: Base Set
         logo:
           type: string

server/package.json

@@ -17,12 +17,15 @@
 		"express": "^4",
 		"graphql": "^15",
 		"graphql-http": "^1.22.1",
-		"ruru": "^2.0.0-beta.14"
+		"ruru": "^2.0.0-beta.14",
+		"swagger-ui-express": "^5.0.1",
+		"yaml": "^2.5.0"
 	},
 	"devDependencies": {
 		"@types/apicache": "^1",
 		"@types/express": "^4",
 		"@types/node": "^20",
+		"@types/swagger-ui-express": "^4.1.6",
 		"glob": "^10",
 		"typescript": "^4"
 	}

server/src/V2/endpoints/openapi.ts

@@ -0,0 +1,18 @@
+
+import express from 'express'
+import fs from 'node:fs'
+import swaggerUi from 'swagger-ui-express'
+import YAML from 'yaml'
+
+const file = fs.readFileSync('./public/v2/openapi.yaml', 'utf8')
+const swaggerDocument = YAML.parse(file)
+
+const server = express.Router()
+
+server.use('/', swaggerUi.serve, swaggerUi.setup(swaggerDocument, {
+	customCss: '.topbar { display: none }',
+	customfavIcon: '/favicon.ico',
+	customSiteTitle: 'Openapi documentation - TCGdex API'
+}))
+
+export default server

server/src/index.ts

@@ -1,5 +1,6 @@
 import express, { type Response } from 'express'
 import jsonEndpoints from './V2/endpoints/jsonEndpoints'
+import openapi from './V2/endpoints/openapi'
 import graphql from './V2/graphql'
 import { Errors, sendError } from './libs/Errors'
 import status from './status'
@@ -66,6 +67,7 @@ server.use(express.static('./public'))
 
 // Setup GraphQL
 server.use(`/v${VERSION}/graphql`, graphql)
+server.use(`/v${VERSION}/openapi`, openapi)
 
 // Setup JSON endpoints
 server.use(`/v${VERSION}`, jsonEndpoints)