TurpleCubes API Contract

Getting Started

To get started with the TurpleCubes API Contract, follow these steps:

1. Clone the repository:

   git clone https://github.com/turplespace/TurpleCubes-contract.git
   cd turplecubes/TurpleCubes-contract

2. Install the dependencies:

   npm install

3. Build the project:

   npm run build

4. Generate the OpenAPI schema:

   After running the build command, you will get a schema.yaml file in the project directory.

5. View the API documentation:

   Take the schema.yaml file and paste its content into Swagger Editor to see the API documentation.

   • Open Swagger Editor
   • Copy the content of schema.yaml
   • Paste it into the editor

This will allow you to visualize and interact with the API documentation.