YGOPRODeck OpenAPI

❗ DISCLAIMER: This is a third-party project based on the YGOPRODeck API by YGOPRODeck and does not have any affiliation with it ❗

This project contains the OpenAPI description of the YGOPRODeck API. We aim to provide a documentation-as-code describing the API to allow developers to:

• Test the API through the live-document
• Use the unbundled OpenAPI file directly from GitHub through the ygoprodeck-api.yaml file.
• Use the released artifacts (see the Releases on GitHub) directly:
  • ygoprodeck-api.yaml provides a bundled OpenAPI description to be used for code generation.
  • ygoprodeck.postman.json to test and interact with the API through Postman.

Note that as a third-party project without affiliation to the YGOPRODeck API the interoperability might be broken. We rely on your help to keep it in sync through pull-requests and/or issues.

Contributing

Please read CONTRIBUTING.md. for details on our code of conduct, and the process for collaborating on the project.

Bug reports

Before submitting a new bug report, please search for keywords in our Issue Tracker. If you cannot find your problem, fill in a new issue.

Getting started

Pre-requisites

The project only requires npm to be installed, relying on the npx command to run redocly and portman.

We recommend to use an IDE with support for OpenAPI to edit the YAML files.

Postman can also be used to open both artifacts (OpenAPI and postman collection).

Build & Test

To build and test the description and postman collection run make. This will create the following artifacts:

• dist/ygoprodeck-api.yaml - bundled OpenAPI YAML
• dist/ygoprodeck.postman.json - postman collection JSON

Bundle only

To bundle the API into a single file, run make build. This script also performs the validation and if the definition is not valid it won't create the bundle.

To create the postman collection without tests, run make postman-collection

Test only

To only run the tests with newman, run make test (as it is run with portman, the postman collection would be also created). This requires that a build for the bubdled OpenAPI description is alredy in place.

LICENSE

This project is provided with the the The Unlicense license.

The YGOPRODeck API is not affiliated with this project and it is provided as a public API by its author.