#api-client #batch #generated #engine #open-api #model #codegen

headless_batch_engine

Liferay DXP 的批量引擎 API 的客户端和模型库,由 open-api-generator 自动生成

1 个不稳定版本

0.1.0 2023年3月17日

#60 in #batch


用于 3 crates

MIT/Apache

79KB
2K SLoC

batch_api 的 Rust API 客户端

可用于组 ID 'com.liferay'、工件 ID 'com.liferay.headless.batch.engine.client' 和版本 '1.0.11' 的 Java 客户端 JAR。

概述

此 API 客户端由 OpenAPI Generator 项目生成。通过使用来自远程服务器的 openapi-spec,您可以轻松地生成 API 客户端。

  • API 版本:v1.0
  • 包版本:v1.0
  • 构建包:org.openapitools.codegen.languages.RustClientCodegen

安装

将包放在项目文件夹中名为 batch_api 的目录下,并在 Cargo.toml 下的 [dependencies] 中添加以下内容

batch_api = { path = "./batch_api" }

API 端点文档

所有 URI 都是相对于 https://127.0.0.1:8080/o/headless-batch-engine

方法 HTTP 请求 描述
DefaultApi get_open_api GET /v1.0/openapi.{type}
ExportTaskApi get_export_task GET /v1.0/export-task/{exportTaskId}
ExportTaskApi get_export_task_by_external_reference_code GET /v1.0/export-task/by-external-reference-code/{externalReferenceCode}
ExportTaskApi get_export_task_by_external_reference_code_content GET /v1.0/export-task/by-external-reference-code/{externalReferenceCode}/content
ExportTaskApi get_export_task_content GET /v1.0/export-task/{exportTaskId}/content
ExportTaskApi post_export_task POST /v1.0/export-task/{className}/{contentType}
ImportTaskApi delete_import_task1 DELETE /v1.0/import-task/{className}
ImportTaskApi get_import_task GET /v1.0/import-task/{importTaskId}
ImportTaskApi get_import_task_by_external_reference_code GET /v1.0/import-task/by-external-reference-code/{externalReferenceCode}
ImportTaskApi get_import_task_by_external_reference_code_content GET /v1.0/import-task/by-external-reference-code/{externalReferenceCode}/content
ImportTaskApi get_import_task_by_external_reference_code_failed_item_report GET /v1.0/import-task/by-external-reference-code/{externalReferenceCode}/failed-items/report
ImportTaskApi 获取导入任务内容 GET /v1.0/import-task/{importTaskId}/content
ImportTaskApi 获取导入任务失败项报告 GET /v1.0/import-task/{importTaskId}/failed-items/report
ImportTaskApi post_import_task1 POST /v1.0/import-task/{className}
ImportTaskApi put_import_task1 PUT /v1.0/import-task/{className}

模型文档说明

要获取生成的文档,请使用

cargo doc --open

作者

依赖项

~5–21MB
~277K SLoC