В тази статия ще обсъдим как да се свърже с проект Swagger Maven, която реализира REST-servesy чрез прилагане спецификация JAX-RS - RESTEasy. В статията ще бъдат боядисани Swagger връзка с проекта, документиране на употреба почивни услуги използвате пояснения, описания на документи изображения чрез уеб интерфейс.

Swagger връзка с проекта

Свързване на Maven зависимостта

За да започнете, трябва да добавим към Maven проект зависимостта на Swagger'a. Тъй като ние ще бъдат свързани към Swagger RESTEasy, добавете подходящата зависимост.

В момента на писането на потребителя най-новата версия е 1.5.6.

Трябва да се помни, че Swagger е наследство Maven хранилището. В lagecy хранилище groupId = com.wordnik. Необходимо е да се вземе това предвид и да не се обърка зависимостта!

Повече информация може да намерите тук.

Създаване на проекта

След това трябва да се свърже с проекта изисква студентите (слушателите), за да може да открива автоматично Swagger анотации и генериране на документация.

Ние правим корекции с помощта на потомък клас javax.ws.rs.core.Application.
Настройката ще изглежда така:

За повече информация за други методи за свързване може да се прочете тук.

Setting Swagger

На следващо място, трябва да зададете настройките на перчене. Направихме го в конструктора на наследника на клас за кандидатстване.

За повече информация за други методи за настройка може да се намери тук.

На първо място, ще опиша пояснителните бележки, които са необходими за правилното документация и правилното показване на REST услуги на Swagger-UI.

За да перчене решена, че в класа са почивни услуги, клас трябва да бъдат маркирани с @Api на анотация. Параметрите на тази анотация, можете да укажете името на секцията, която ще се намира REST'y в потребителския интерфейс и въведете описание на тази секция.
Например:

@ApiOperation

@ApiOperation анотация трябва да бъдат посочени върху чрез REST услуги. Също така е възможно да се уточни параметрите на описанието на услугата.

други пояснения

За изрична Хедър, които са задължителни за определена услуга, можете да използвате анотация

За да укажете в обект на отговор, можете да използвате анотация @ApiResponse. Това ще бъде от полза, ако отговор от сървъра на REST връща отговор обект.

За повече информация за всички пояснения, може да намерите тук.

За да зададете адреса по подразбиране, който искате да редактирате изходния код на файла index.html

След това ще видим нашите документация почивни услуги. Запитване почивни услуги могат да бъдат директно от потребителския интерфейс.

Ако Swagger да генерира грешка can`t донесе ще трябва да се направи настройка Cors заглавията в сървъра, на който zadeploeno нашата молба, ние трябва да добавите заглавната Access-Control-Allow-произход: *

Примерни почивни услуги на UI:

Списък на REST услуги на уеб-интерфейса:

Форма на подробна информация за REST-услуги и възможност за изпращане на заявката.