Der Artikel erläutert die REST-API Dokumentation mittels RAML. Einführend wird ein kurzer Überblick gegeben welche vergleichenbaren Tools auf dem Mark existieren dann werden die Feature von RAML an Spezifikations- und Kodebeispielen dargestellt.
Description
Das Konzept ist super allein die Umsetzung scheint für eine Java Maven Integration noch nicht voll geeignet zu sein.
Für jUnit Tests scheint es bereits einsetzbar zu sein aber die Generierung der HTML Dokumentation basiert auf npm und ist damit erst ab Java8 lauffähig (falls nashorn mit dem verwendeten node-js kompatible ist).
%0 Journal Article
%1 spichale2015first
%A Spichale, Kai
%D 2015
%J Java Magazin
%K documentation raml rest rest-api
%N 4
%P 96-99
%T API First mit RAML - Entwicklung und Dokumentation von REST-APIs
%X Der Artikel erläutert die REST-API Dokumentation mittels RAML. Einführend wird ein kurzer Überblick gegeben welche vergleichenbaren Tools auf dem Mark existieren dann werden die Feature von RAML an Spezifikations- und Kodebeispielen dargestellt.
@article{spichale2015first,
abstract = {Der Artikel erläutert die REST-API Dokumentation mittels RAML. Einführend wird ein kurzer Überblick gegeben welche vergleichenbaren Tools auf dem Mark existieren dann werden die Feature von RAML an Spezifikations- und Kodebeispielen dargestellt.},
added-at = {2015-04-25T16:34:01.000+0200},
author = {Spichale, Kai},
biburl = {https://www.bibsonomy.org/bibtex/294f86c9f252fc214081f44e7fdca5bed/funthomas424242},
description = {Das Konzept ist super allein die Umsetzung scheint für eine Java Maven Integration noch nicht voll geeignet zu sein.
Für jUnit Tests scheint es bereits einsetzbar zu sein aber die Generierung der HTML Dokumentation basiert auf npm und ist damit erst ab Java8 lauffähig (falls nashorn mit dem verwendeten node-js kompatible ist).},
interhash = {269a10b586ea1d19cd04afb961d28297},
intrahash = {94f86c9f252fc214081f44e7fdca5bed},
journal = {Java Magazin},
keywords = {documentation raml rest rest-api},
number = 4,
pages = {96-99},
timestamp = {2015-04-25T16:34:01.000+0200},
title = {API First mit RAML - Entwicklung und Dokumentation von REST-APIs},
year = 2015
}