Rámec pro přístup ke vzdáleným zdrojům s podporou samodokumentujícího se API

Abstract

Tato práce se zabývá návrhem protokolu pro dokumentování serverových API s využitím protokolu HTTP a architektury REST. Součástí projektu je referenční implementace protokolu ve formě frameworku sloužícího k tvorbě API serveru, který je pomocí reflexe a doménového jazyka schopen výsledné API sám zdokumentovat a tuto dokumentaci předat klientům ve strojově čitelné formě. Referenční implementace dále obsahuje klientské knihovny v několika programovacích jazycích. Nad těmito knihovnami je pak postaveno uživatelské rozhraní ve formě webové administrace, rozhraní v příkazové řádce a virtuálního souborového systému. Každý klient a nad ním postavená aplikace dokáže pracovat s jakýmkoli API, které implementuje definovaný protokol.

The goal of this thesis is to design a protocol to document server APIs with the use of the HTTP protocol and REST architecture. Included is a reference implementation of said protocol in the form of a framework that can be used to create server API. The framework uses reflection and a domain-specific language to document itself and is able to pass this documentation in a machine-readable form to clients. The reference implementation also contains client libraries in several programming languages. There are three user interfaces built on top of these libraries: a web administration, a command-line interface and a virtual file system. All clients and applications can be used with any API that implements the created protocol.