Skip to content

Metadata API development

AndreasHuber edited this page Mar 28, 2024 · 11 revisions

Introduction

The Serlo Metadata API, described for users at this page allows downloading the metadata of Serlo content. It is mainly used by content aggregators like

  • WirLernenOnline.de
  • Bildungsserver.de
  • edutags.de
  • NBP Datenraum (not yet publicly accessible?)

that we want to support via our Metadata API so that teachers and students can find Serlo content on those pages.

Format

The metadata is provided in a standardized format called Allgemeines Metadatenprofil für Bildungsressourcen (AMB) which translates to "general metadata profile for educational resources". Serlo is also involved in the AMB standard committee. The AMB standard uses vocabulary from the Schema.org standard with JavaSript Object Notation Linked Data (JSON-LD) encoding. You can learn more about JSON-LD here.

Source

The core logic of the implementation is in https://github.com/serlo/database-layer/blob/main/server/src/metadata.rs with tests in https://github.com/serlo/database-layer/blob/main/server/tests/integration/metadata.rs.

Clone this wiki locally