В этой статье представлен пример использования Swagger2 в Spring Boot Project. Это совместно с вами. Детали следующие:
Добавить зависимости Swagger2
Добавить зависимости Swagger2 в pom.xml
<depervice> <groupid> io.springfox </groupid> <artifactid> Springfox-swagger2 </artifactid> <sersive> 2.2.2 </version> </depervice> <dependency> <groupid> io.springfox </groupd> <artifactid> springfox-wger-uii </artifactid> <serse> 2.2.2 <//версия <//версия <//версия <//версия <//версия <//версия <//версия <//версия <//версия <//версия <//версия <//версия </arsemence >2 <//версия <//версия </deperence >2.2.2 <//ryperence >2.
Создать класс конфигурации Swagger2
Создайте класс конфигурации Swagger2 Swagger2 в Application.java Одновременный уровень.
Импорт org.springframework.context.annotation.bean; импорт org.springframework.context.annotation.configuration; импорт springfox.documentation.builders.apiinfobuilder; импорт Springfox.documentation.Builders.PathseSelectors; импорт Springfox.Documents.Requilders. springfox.documentation.service.apiinfo; import springfox.documentation.spi.documentationtype; import springfox.documentation.spring.web.plugins.docket; import springfox.documentation.swagger2.annotations.Enableswagger2;@confighater@envagevager2public swager2 @beantables. {return new Docket (documentType.swagger_2) .apiinfo (apiinfo ()). Select () .Apis (requestHandlerselectors.basepackage ("Ваше собственное имя пакета интерфейса")) .paths (pathselectors.any ()) .build (); } private apiinfo apiinfo () {return new apiinfobuilder () .title ("neo4j restful apis") .description ("neo4j Restful apis descis/") .TermSofServiceUrl (") .contact (" li Qinghai ") .version (" 5.0 "). }}Добавить содержимое документа
После завершения вышеуказанной конфигурации содержание документа может быть фактически создано, но такие документы в основном направлены на сам запрос, и описание в основном происходит от именования функций и других функций, что не является удобным для пользователя. Обычно нам нужно добавить несколько инструкций для обогащения содержания документа.
Импорт io.swagger.annotations.api; import io.swagger.annotations.apioperation; import io.swagger.annotations.apiparam;/** * Системный пользовательский контроллер * * @author li Qinghai * */@api (value = "Системный пользовательский интерфейс", tags = "Системный Usercontroller {@autowired private userservice userservice; /** * Add user, register * * @param loginName * Log in to account* @param userName * User name* @param password * Login password* @param roleId * User role* @return * @throws ResourceExistsException */ @ApiOperation(value = "Add user") @PostMapping("/") public JsonResult create( @ApiParam(name = "loginName", value = "Login Учетная запись ", обязательно = true) @RequestParam (обязательно = true) @Requestbody String loginName, @apiparam (name =" username ", value =" имя пользователя ", обязательно = true) @RequestParam (обязательно = true) @Requestbody String usernam @Apiparam (name = "roleid", value = "№" номер роли пользователя ", обязательный = true) @RequestParam (требуется = true) @Requestbody String Roleid) Throws resourceExistsexception {boolean существует = this.UserService.exists (loginName); if (существует) {бросить новый ресурсоэксистсексапс (loginName); } User user = userservice.create (loginName, пароль, имя пользователя, Roleid); вернуть новый jsonResult (пользователь); }}Посмотреть API
Запуск Spring Boot Программа и посетите: http: // localhost: 8080/swagger-ui.html
Доступ к документу API и отладка
В дополнение к просмотру функции интерфейса, Swagger также предоставляет функции отладки и тестирования. Мы можем нажать на схему модели (желтая область: она указывает структуру данных) справа на рисунке выше. В настоящее время в значении есть шаблон для объекта пользователя. Нам нужно лишь немного изменить его, нажмите «Попробуй это» ниже! Кнопка, вы можете завершить запрос! Несколько запросов GET можно использовать для проверки того, что предыдущий запрос POST является правильным.
Выше всего содержание этой статьи. Я надеюсь, что это будет полезно для каждого обучения, и я надеюсь, что все будут поддерживать Wulin.com больше.