GROOVYSCHOOL API DOCUMENTATION

This project contains the documentation for the GROOVYSCHOOL REST API

Prerequisites

In order to run this project, you will need the following tools installed.

1. The node package manager npm.

This comes bundled with node.js and can be installed by following the instructions on the Node.js official download page

How to run

1. Clone this repository into a folder of your choice on your computer.

2. Open your terminal and move to the cloned directory

3. Install Redoc CLI with the command npm i redoc-cli g

   1. Serve the spec file with npx redoc-cli serve api-spec.yaml

4. Create a deployable zero-dependency HTML file

   1. Generate the html with npx redoc-cli bundle api-spec.yaml

More info about the CLI can be found on the redoc site