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:
These activities are planned for the next period:
- Discuss & process additions and improvements in separate v2 branch
- The scope of the V2 specification will be frozen by May 15, 2017
- The V2 specification will be finalized by the end of June 2017
The specification can be rendered as HTML documentation:
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
The Open Education API is an open source, community-driven project. If you'd like to contribute, please follow the Contributing Guidelines.
The Open Education API is driven by the Open Education API Working Group. The working group includes representatives of higher education institutions and suppliers.