Einführung in RAML - Die RESTful API Modeling Language

1. Überblick

In diesem Artikel stellen wir die RESTful API Modeling Language (RAML) vor, eine herstellerneutrale Sprache mit offener Spezifikation, die auf http://yaml.org/spec/1.2/spec basiert .html[YAML 1.2]und JSON zum Beschreiben von RESTful-APIs.

In diesem Artikel wird die grundlegende RAML 1.0-Syntax und die Dateistruktur beschrieben. Außerdem wird gezeigt, wie eine einfache JSON-basierte API definiert wird. Wir zeigen auch, wie Sie die Pflege von RAML-Dateien durch die Verwendung von includes vereinfachen. Wenn Sie über ältere APIs verfügen, die ein JSON-Schema verwenden, zeigen wir Ihnen, wie Sie Schemas in RAML integrieren.

Anschließend stellen wir Ihnen eine Handvoll Tools vor, die Ihnen den Einstieg in RAML erleichtern können, darunter Authoring-Tools, Dokumentationsgeneratoren und andere.

Abschließend beschreiben wir den aktuellen Status der RAML-Spezifikation.