Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 991 Bytes

File metadata and controls

32 lines (21 loc) · 991 Bytes

OCCAPI OpenAPI definition & demo

This repository contains the OpenAPI specification for the Open Course Catalogue API along with a working demo for development reference.

Issues

Use the issue queue to report any issues or questions related to the specification.

Pull requests will be considered when concerning the contents of the openapi/v2/components directory.

Pull requests concerning the build tools are discouraged.


Quickstart

# Clone the repository
git clone git@github.com:EuropeanUniversityFoundation/occapi-openapi.git
# Create an environment file
cp .env.example .env
# Review parameters: DEFINITION, BUNDLE
nano .env
# Validate the specification
make lint
# Bundle the specification
make bundle

Stack

Built with Redocly CLI and Slim - a micro framework for PHP.