org.apache.camel.model.rest.RestDefinition.description()方法的使用及代码示例

x33g5p2x  于2022-01-29 转载在 其他  
字(11.1k)|赞(0)|评价(0)|浏览(79)

本文整理了Java中org.apache.camel.model.rest.RestDefinition.description方法的一些代码示例，展示了RestDefinition.description的具体用法。这些代码示例主要来源于Github/Stackoverflow/Maven等平台，是从一些精选项目中提取出来的代码，具有较强的参考意义，能在一定程度帮忙到你。RestDefinition.description方法的具体详情如下：
包路径：org.apache.camel.model.rest.RestDefinition
类名称：RestDefinition
方法名：description

RestDefinition.description介绍

暂无

代码示例

代码示例来源：origin: org.openksavi.sponge/sponge-rest-api-server

protected <I extends SpongeRequest, O extends SpongeResponse> void createOperation(RestDefinition restDefinition, String operation,
    String operationDescription, Class<I> requestClass, String requestDescription, Class<O> responseClass,
    String responseDescription, BiFunction<I, Exchange, O> operationHandler) {
  restDefinition.post(operation).description(operationDescription).type(requestClass).outType(responseClass).param().name("body")
      .type(body).description(requestDescription).endParam().responseMessage().code(200).message(responseDescription)
      .endResponseMessage().route().id("sponge-" + operation).process(exchange -> {
        String requestBody = exchange.getIn().getBody(String.class);
        if (logger.isDebugEnabled()) {
          logger.debug("REST API {} request: {}", operation, RestApiUtils.obfuscatePassword(requestBody));
        }
        try {
          setupResponse(operation, exchange,
              operationHandler.apply(getObjectMapper().readValue(requestBody, requestClass), exchange));
        } catch (Throwable processingException) {
          logger.info("REST API error", processingException);
          try {
            setupResponse(operation, exchange, apiService.createGenericErrorResponse(processingException, exchange));
          } catch (Throwable e) {
            logger.error("REST API send error response failure", e);
            throw e;
          }
        }
      }).endRest();
}

代码示例来源：origin: camelinaction/camelinaction2

@Override
  public void configure() throws Exception {

    // use jetty for rest service
    restConfiguration("jetty").port("{{port}}").contextPath("api")
        // turn on json binding
        .bindingMode(RestBindingMode.json)
        // turn off binding error on empty beans
        .dataFormatProperty("disableFeatures", "FAIL_ON_EMPTY_BEANS")
        // enable swagger api documentation
        .apiContextPath("api-doc")
        .enableCORS(true);

    // define the rest service
    rest("/cart").consumes("application/json").produces("application/json")
      // get returns List<CartDto>
      .get().outType(CartDto[].class).description("Returns the items currently in the shopping cart")
        .to("bean:cart?method=getItems")
      // get accepts CartDto
      .post().type(CartDto.class).description("Adds the item to the shopping cart")
        .to("bean:cart?method=addItem")
      .delete().description("Removes the item from the shopping cart")
        .param().name("itemId").description("Id of item to remove").endParam()
        .to("bean:cart?method=removeItem");
  }
}

代码示例来源：origin: camelinaction/camelinaction2

@Override
  public void configure() throws Exception {

    // use jetty for rest service
    restConfiguration("jetty").port("{{port}}").contextPath("api")
        // turn on json binding
        .bindingMode(RestBindingMode.json)
        // turn off binding error on empty beans
        .dataFormatProperty("disableFeatures", "FAIL_ON_EMPTY_BEANS")
        // enable swagger api documentation
        .apiContextPath("api-doc")
        .enableCORS(true);

    // define the rest service
    rest("/cart").consumes("application/json").produces("application/json")
      // get returns List<CartDto>
      .get().outTypeList(CartDto.class).description("Returns the items currently in the shopping cart")
        .to("bean:cart?method=getItems")
      // get accepts CartDto
      .post().type(CartDto.class).description("Adds the item to the shopping cart")
        .to("bean:cart?method=addItem")
      .delete().description("Removes the item from the shopping cart")
        .param().name("itemId").description("Id of item to remove").endParam()
        .to("bean:cart?method=removeItem");
  }
}

代码示例来源：origin: org.openksavi.sponge/sponge-rest-api

RestDefinition restDefinition = rest(RestApiConstants.BASE_URL).description("Sponge REST API")
  .consumes(RestApiConstants.APPLICATION_JSON_VALUE).produces(RestApiConstants.APPLICATION_JSON_VALUE)
  .post("/version").description("Get the Sponge version").type(RestGetVersionRequest.class).outType(RestGetVersionResponse.class)
    .param().name("body").type(body).description("Get Sponge version request").endParam()
    .responseMessage().code(200).message("The Sponge version response").endResponseMessage()
      .setBody(exchange -> apiService.getVersion(exchange.getIn().getBody(RestGetVersionRequest.class), exchange))
    .endRest()
  .post("/login").description("Login").type(RestLoginRequest.class).outType(RestLoginResponse.class)
    .param().name("body").type(body).description("Login request").endParam()
    .responseMessage().code(200).message("The login response").endResponseMessage()
      .setBody(exchange -> apiService.login(exchange.getIn().getBody(RestLoginRequest.class), exchange))
    .endRest()
  .post("/logout").description("Logout").type(RestLogoutRequest.class).outType(RestLogoutResponse.class)
    .param().name("body").type(body).description("Logout request").endParam()
    .responseMessage().code(200).message("The logout response").endResponseMessage()
      .setBody(exchange -> apiService.logout(exchange.getIn().getBody(RestLogoutRequest.class), exchange))
    .endRest()
  .post("/knowledgeBases").description("Get knowledge bases").type(RestGetKnowledgeBasesRequest.class)
      .outType(RestGetKnowledgeBasesResponse.class)
    .param().name("body").type(body).description("Get knowledge bases request").endParam()
      .setBody(exchange -> apiService.getKnowledgeBases(exchange.getIn().getBody(RestGetKnowledgeBasesRequest.class), exchange))
    .endRest()
  .post("/actions").description("Get actions").type(RestGetActionsRequest.class).outType(RestGetActionsResponse.class)
    .param().name("body").type(body).description("Get actions request").endParam()
    .responseMessage().code(200).message("The get actions response").endResponseMessage()

代码示例来源：origin: RedHatWorkshops/dayinthelife-integration

rest("/location").description("Location information")
  .produces("application/json")
  .get("/contact/{id}").description("Location Contact Info")
    .responseMessage().code(200).message("Data successfully returned").endResponseMessage()
    .to("direct:getalllocationphone")

代码示例来源：origin: RedHatWorkshops/dayinthelife-integration

rest("/locations").description("Location information")
  .produces("application/json")
  .get("/").description("Retrieve all locations data")
    .to("direct:getlocationAll")
  .get("/{id}")

代码示例来源：origin: org.openksavi.sponge/sponge-rest-api-server

protected void createRestDefinition() {
    RestDefinition restDefinition = rest(getSettings().getPath()).description("Sponge REST API");

    createOperation(restDefinition, RestApiConstants.OPERATION_VERSION, "Get the Sponge version", GetVersionRequest.class,
        "Get Sponge version request", GetVersionResponse.class, "The Sponge version response",
        (request, exchange) -> apiService.getVersion(request, exchange));
    createOperation(restDefinition, RestApiConstants.OPERATION_LOGIN, "Login", LoginRequest.class, "Login request", LoginResponse.class,
        "The login response", (request, exchange) -> apiService.login(request, exchange));
    createOperation(restDefinition, RestApiConstants.OPERATION_LOGOUT, "Logout", LogoutRequest.class, "Logout request",
        LogoutResponse.class, "The logout response", (request, exchange) -> apiService.logout(request, exchange));
    createOperation(restDefinition, RestApiConstants.OPERATION_KNOWLEDGE_BASES, "Get knowledge bases", GetKnowledgeBasesRequest.class,
        "Get knowledge bases request", GetKnowledgeBasesResponse.class, "The get knowledge bases response",
        (request, exchange) -> apiService.getKnowledgeBases(request, exchange));
    createOperation(restDefinition, RestApiConstants.OPERATION_ACTIONS, "Get actions", GetActionsRequest.class, "Get actions request",
        GetActionsResponse.class, "The get actions response", (request, exchange) -> apiService.getActions(request, exchange));
    createOperation(restDefinition, RestApiConstants.OPERATION_CALL, "Call an action", ActionCallRequest.class, "Call action request",
        ActionCallResponse.class, "The action call response", (request, exchange) -> apiService.call(request, exchange));
    createOperation(restDefinition, RestApiConstants.OPERATION_SEND, "Send a new event", SendEventRequest.class, "Send event request",
        SendEventResponse.class, "The send event response", (request, exchange) -> apiService.send(request, exchange));
    createOperation(restDefinition, RestApiConstants.OPERATION_ACTION_ARGS, "Provide action arguments",
        ProvideActionArgsRequest.class, "The provide action arguments request", ProvideActionArgsResponse.class,
        "The provide action arguments response", (request, exchange) -> apiService.provideActionArgs(request, exchange));

    if (getSettings().isPublishReload()) {
      createOperation(restDefinition, RestApiConstants.OPERATION_RELOAD, "Reload knowledge bases", ReloadRequest.class,
          "Reload knowledge bases request", ReloadResponse.class, "The reload response",
          (request, exchange) -> apiService.reload(request, exchange));
    }
  }
}

代码示例来源：origin: RedHatWorkshops/dayinthelife-integration

rest("/locations").description("Location information")
  .produces("application/json")
  .get("/").description("Retrieve all locations data")
    .responseMessage().code(200).message("Data successfully returned").endResponseMessage()
    .to("direct:getalllocations")

代码示例来源：origin: camelinaction/camelinaction2

rest("/orders").description("Order services")
    .description("Service to get details of an existing order")
    .param().name("id").description("The order id").endParam()
    .responseMessage().code(200).message("The order with the given id").endResponseMessage()
    .description("Service to submit a new order")
    .responseMessage()
      .code(200).message("The created order id")
    .description("Service to update an existing order")
    .responseMessage().code(400).message("Invalid input data").endResponseMessage()
    .responseMessage().code(500).message("Server error").endResponseMessage()
    .description("Service to cancel an existing order")
    .param().name("id").description("The order id").endParam()
    .responseMessage().code(404).message("Order not found").endResponseMessage()

代码示例来源：origin: RedHatWorkshops/dayinthelife-integration

rest("/threescale").description("Location information")
  .produces("application/json")
  .post("/automate/{apiToken}/{userid}/{openshiftappurl}").description("Automatically setup your 3scale APIs")
    .responseMessage().code(200).message("Your API is secured!").endResponseMessage()
    .to("direct:threescalesetup")

内容来源于网络，如有侵权，请联系作者删除！

RestDefinition

相关文章

    查看更多
    微信公众号

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新文章

    更多
    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com