Dokumentační nástroj pro aplikační rozhraní REST

Bc. Michal Novák

Master's thesis

REST API documentation tool

Anotácia:

Cílem práce bylo seznámit se s architektonickým stylem REST a vytvořit nástroj pro dokumentaci a analýzu aplikačního rozhraní REST. Nástroj měl zároveň umožňovat validaci požadavků. Implementace podporuje konstrukci popisu z WADL souborů nebo Java archivů. Podporované formáty výstupu jsou HTML dokumentace pro uživatele a WADL soubor. K tomu je možné sestavit klienta, který komunikuje s daným rozhraním přes protokol HTTP. Program byl napsán v programovacím jazyce Java. Program je možno užívat z příkazové řádky nebo jako programovou knihovnu.

Abstract:

The goal of the thesis was to study software architecture REST and create tool that would make possible to describe and analyze application interface REST. Tool should allow to validate requests based on the description. The implementation supports description based on WADL formatted file or Java archive. Supported formats of output are: HTML documentation for user and WADL file. It is also possible to generate client which is capable of communication with given REST interface over HTTP protocol. The utility has been written in Java programming language. Utility might be used either from command line or as Java library.

Kľúčové slová

REST, webové služby, HTTP, dokumentace, klient-server, WADL, RESTful

Jazyk práce: Czech

Datum vytvoření / odevzdání či podání práce: 7. 1. 2013

Obhajoba závěrečné práce

• Obhajoba proběhla 8. 2. 2013
• Vedúci: Mgr. Marek Grác, Ph.D.
• Oponent: RNDr. Pavel Šmerk, Ph.D.

Masaryk University

Faculty of Informatics

Master programme / odbor:
Informatics / Information Systems