Web 与 HTTP 服务
API 文档
你当前正在浏览历史版本 Vert.x 4.3.8 的文档。 前往 最新版本文档首页。

Vert.x Web OpenAPI 路由中心

本模块为 Vert.x Web 提供了对 OpenAPI 3 契约规范的原生解析、校验与自动化路由派发支持。

依赖引入

  • Maven (pom.xml):

<dependency>
 <groupId>io.vertx</groupId>
 <artifactId>vertx-web-openapi</artifactId>
 <version>4.5.35</version>
</dependency>

创建 RouterBuilder

通过异步加载本地或远程 OpenAPI 规范契约构建路由：

RouterBuilder.create(vertx, "openapi.yaml")
  .onSuccess(routerBuilder -> {
    routerBuilder.operation("getUser")
      .handler(ctx -> {
        RequestParameters params = ctx.get(ValidationHandler.REQUEST_CONTEXT_KEY);
        String userId = params.pathParameter("userId").getString();
        ctx.json(new JsonObject().put("id", userId));
      });

    Router router = routerBuilder.createRouter();
    vertx.createHttpServer().requestHandler(router).listen(8080);
  });