HaveAPI v0.4 - Community-list

20 Jan 2016

Ahoj,

uzavřel jsem další verzi frameworku HaveAPI [1], na němž je postaven
vpsAdmin.

Verze 0.4 přináší:

 - definici verze komunikačního protokolu, aktuálně 1.0,
 - validátory vstupních parametrů,
 - definované hooky [2] součástí referenční dokumentace [3] generované
   s yardoc,
 - styly + prolinkování resources v online dokumentaci API,
 - JSON schema dokumentačního protokolu [4], znázornění v UML [5],
 - lepší hlášení chyb při inicializaci API.

Validátory jsou jako většina věcí v HaveAPI součástí dokumentace [6]
API, takže se parametry mohou validovat na straně klienta ještě před
posláním dat na server. Validátory jsou nyní nezávislé na ActiveRecord.
Při jeho použití se kompatibilní validátory z modelů přenesou i na
validátory vstupních parametrů a jsou součástí dokumentace.

Velkých změn se dočkalo CLI [7] v Ruby:

 - zahozen gem table_print a výstup formátován svépomocí buď do řádků
   (-r, --rows), nebo sloupců (-c, --columns),
 - -o, --output vypíše pouze vybrané parametry,
 - -s, --sort seřadí výstup podle parametru (na straně klienta),
 - -L, --list vypíše seznam výstupních parametrů vybrané akce,
 - -H, --no-header potlačí výpis hlavičky s názvy parametrů,
 - --timestamp, --utc, --local a --date-format na formátování Datetime
   parametrů.

Klient v JavaScriptu je nově k dispozici přes npm [8] (Node.js) a bower [9].

[1] https://github.com/vpsfreecz/haveapi

[2] https://projects.vpsfree.cz/haveapi/ref/HaveAPI/Hooks.html

[3] https://projects.vpsfree.cz/haveapi/ref/file.Hooks.html

[4] https://projects.vpsfree.cz/haveapi/ref/file.JSON-Schema.html

[5]
https://github.com/vpsfreecz/haveapi/blob/master/lib/haveapi/public/doc/pro…

[6] https://github.com/vpsfreecz/haveapi/blob/master/doc/protocol.md

[7] https://github.com/vpsfreecz/haveapi-client#cli

[8] https://www.npmjs.com/package/haveapi-client

[9] http://bower.io

Jakub