OpenAPI (fka Swagger) specification for the Open Education API.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
definitions
paths
CONTRIBUTING.md
Governance.md
LICENSE.md
OOAPI_model.jpg
README.md
ROADMAP.md
docs.html
logo.png
spec.yaml

README.md

Open Education API Specification

Open Education API

This repository contains the OpenAPI (fka Swagger) specification for the Open Education API.

If you have a question, an idea or some feedback unrelated to the specification, please visit the community site.

Currently there are 2 main branches:

  • v2 (Current version - final)
  • v1 (Previous version - stale)

Operating area and Application

The Open Education API is typically used to make educational data available. With educational data we mean the data that is typically stored in the educational systems like the Student Information System (SIS), the Learning Management System (LMS) etc. Think of marks and study credits, couse information, schedules and timetables. Education institutions can now publish this educational data in a standardised way by implementing their own Open Education API, following the the Open Education API specification. By doing so, application developers can then integrate education data that has been made available by the Open Education API implementations of the different education institutions in an uniform way, into new exiting applications. See for more information about this project: https://openonderwijsapi.nl/en/

Documentation

The specification can be rendered as HTML documentation:

Development

To render the reference documentation locally during development, you can start a Docker container:

docker run --rm -p 8080:80 -v ${PWD}:/usr/share/nginx/html nginx:alpine

Now you can view the docs in your web browser: http://localhost:8080/docs.html

Contributing

The Open Education API is an open source, community-driven project. If you'd like to contribute, please follow the Contributing Guidelines.

Community

The Open Education API is driven by the Open Education API Working Group. The working group includes representatives of higher education institutions and suppliers.