openapi-processor – это небольшой фреймворк для обработки файлов Open API yaml. В настоящее время openapi-processor обеспечивает генерацию кода java для Spring Boot и преобразование в json.
Он поддерживает gradle и maven для запуска любого openapi-процессора как части процесса сборки.
Дополнительные сведения см. в documentation |/. Существует также playground для предварительного просмотра процессоров.
Плагин maven является новейшим членом семейства процессоров openapi, и в следующих разделах дается краткое введение в его конфигурацию.
Я просто покажу конфигурацию плагина maven для интеграции файла Open API yaml. Я не описываю создание приложения Spring Boot.
Интеграция его в новый проект Spring Boot starter, созданный Spring Initializr (maven и web-mvc) должны работать без проблем.
Чтобы увидеть рабочий демонстрационный проект, взгляните на openapi-processor samples . Доступные образцы имеют pom.xml
и файл build.gradle
, чтобы вы могли создавать их с помощью maven или gradle.
чего ожидать
Предполагая (простой) открытый файл API yaml:
openapi: 3.0.2 info: title: ping api version: 1.0.0 paths: /ping: get: tags: - ping summary: returns a single "pong" string. description: super simple endpoint. responses: '200': description: pong content: text/plain: schema: type: string
плагин openapi-processor-maven создаст интерфейс java, запустив |/openapi-processor-spring (сокращенно oap-spring).
Интерфейс, созданный для простого api, будет выглядеть следующим образом (имя пакета io.open api processor.simple
настраивается):
package io.openapiprocessor.simple.api; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.GetMapping; public interface PingApi { @GetMapping(path = "/ping", produces = {"text/plain"}) String getPing(); }
Теперь вы можете реализовать интерфейс для обеспечения рабочей конечной точки в вашем приложении Spring Boot.
Пример реализует интерфейс с жестко запрограммированным результатом, подобным этому:
package io.openapiprocessor.simple; import io.openapiprocessor.simple.api.PingApi; import org.springframework.http.ResponseEntity; import org.springframework.stereotype.Controller; @RestController public class PingController implements PingApi { @Override public String getPing () { return "pong"; } }
Теперь давайте рассмотрим необходимую конфигурацию для создания интерфейса из maven.
Продолжайте читать здесь .
Первоначально опубликовано на Первоначально опубликовано на 18 июля 2020 года.
Оригинал: “https://dev.to/hauner/configuring-openapi-processor-maven-39pf”