Nástroj pro generování dokumentace vzdálených rozhraní (API) webových služeb aplikací Java Enterprise Edition

Abstract

S narůstajícím počtem softwarových produktů, které mají potřebu být mezi sebou vzájemně integrovány vznikl velký tlak na unifikaci rozhraní. Byla proto vytvořena řada protokolů a technologií, které přinášejí do systémové integrace pravidla a postupy určující, jak probíhá vzdálená komunikace mezi systémy a jak tvořit poskytovatele a klienty takových rozhraní. Pokud existuje k vystavenému rozhraní odpovídající dokumentace, která umožní konzumentovi poskytnout všechny potřebné informace o rozhraní, lze poměrně rychle a jednoduše provést integraci. V opačném případě nekompletní, neaktuální či jinak nedostačující dokumentace může způsobit nárust nákladů na realizování integrace.

Cílem práce je analyzovat požadavky dokumentace a vytvořit nástroj pro automatické generování aktuální dokumentace vzdálených rozhraní. S využitím nástroje dojde ke snížení nákladů potřebných pro tvorbu dokumentace a tím i realizaci systémové integrace.

With the increasing number of software products, which have a need to be integrated in between themselves, a big pressure developed with interface unification. Therefore a row of protocols and technologies was developed, which brings rules into system integration and aproaches, which designate how the remote communication between system should work and how to create providers and clients of such interfaces. If there is a required documentation for an interface, which enables the consumer to obtain all needed information about the interface, it is fairly easy to realize the integration. In reversed case incomplete, nonactual or otherwise insufficient documentation can lead to growth of needed funds for the realization of integration.

The aim of the thesis is to analyze the requirements of the documentation and to develop a tool for automatic generation of actual documentation of remote interfaces. With the usage of the tool there will be a decrease of needed funds for the development of the documentation and for the realization of the system integration.