Telepítése és konfigurálása hetvenkedő, jazzteam szoftverfejlesztő cég

Ebben a cikkben lesz szó, hogyan kell csatlakozni Swagger Maven projekt, ami REST-servesy végrehajtási JAX-RS leírás - RESTEasy. A cikk lesz festve Swagger kapcsolatot a projekt, dokumentálják a REST-szolgáltatások segítségével kommentárok, leírások képalkotó dokumentumok a webes felületen.

Swagger kapcsolat a projekt

Csatlakozó a Maven függőség

Kezdeni, meg kell adni a projekthez Maven függőség Swagger'a. Mivel mi lesz kötve Swagger RESTEasy, majd hozzáadjuk a megfelelő függőséget.

Abban az időben az írás a kézikönyv legújabb verzió 1.5.6.

Emlékeztetni kell arra, hogy Swagger egy örökölt maven tárolóból. A lagecy adattár GrouplD = com.wordnik. Meg kell ezt figyelembe venni, és nem keverjük össze a függőség!

További információ itt található.

Beállítása a projekt

Ezután kell csatlakozni a projekthez szükséges tanulók (hallgatók), a Swagger is automatikusan észleli kommentárok és ezáltal dokumentációt.

Mi lehet beállításokat a leszármazott osztály javax.ws.rs.core.Application.
A beállítás fog kinézni:

További információ a más átviteli módok itt olvasható.

beállítás Swagger

Ezután be kell állítani a beállításokat Swagger. Megcsináltuk a kivitelező az Application osztály örökös.

További információ a többi beállítási módszerek is itt található.

Először is, fogom leírni a címkéket, amelyek szükségesek a megfelelő dokumentációt és helyes megjelenítésének REST szolgáltatások Swagger-UI.

Hogy pöffeszkedik meghatározta, hogy az osztály REST-szolgáltatások, az osztály meg kell jelölni a kommentár @Api. A paraméterei a kommentár, megadhatja a nevét a rész, amelyet található REST'y a UI, és adjon meg egy leírást ebben a fejezetben.
Például:

@ApiOperation

@ApiOperation kommentár kell megadni át REST-szolgáltatás. Szintén lehetőség van arra, hogy adja meg a paramétereket a szolgáltatás leírását.

más kommentárok

Explicit Heather, amelyek feltétlenül szükségesek egy adott szolgáltatásra, akkor egy kommentár

Ahhoz, hogy egyértelműen meg kell határozni a válasz objektumot, akkor a kommentár @ApiResponse. Hasznos lesz, ha a válasz a többi kiszolgáló visszatér responce objektumot.

További információt kommentárok megtalálható itt.

Az alapértelmezett url szerkeszteni kívánt forráskódját az index.html fájlt

Ezután látni fogjuk dokumentációs REST-szolgáltatásokat. Kérdezze le a REST-szolgáltatásokat lehet közvetlenül a felületen.

Ha Swagger hibát generál `t letölteni kell, hogy beállítás CORS fejlécét a szerver, amelyen zadeploeno mi alkalmazás, mi kell hozzá fejléc Access-Control-Allow-Origin: *

Minta REST szolgáltatások UI:

Listája REST szolgáltatást a Web-UI:

Forma részletes információkat a REST-szolgáltatás és a lehetőséget a kérelem elküldését.