23、长时运行操作与可重复运行作业的API设计

http9protocoller

于 2025-07-09 10:26:10 发布

阅读量6

点赞数

CC 4.0 BY-SA版权

分类专栏： API设计模式：构建高效Web API的指南文章标签：长时运行操作 LRO 可重复运行作业

本文链接：https://blog.csdn.net/http9protocoller/article/details/149932018

API设计模式：构建高效Web API的指南专栏收录该内容

50 篇文章 ¥399.00 ¥499.90

订阅专栏

超级会员免费看

长时运行操作与可重复运行作业的API设计

1. 长时运行操作（LRO）的API定义

长时运行操作（LRO）是Web API中的一种设计模式，用于跟踪API服务在后台执行的工作。以下是相关的最终API定义：

abstract class ChatRoomApi {
  @post("/{parent=chatRooms/*}/messages:analyze")
  AnalyzeMessages(req: AnalyzeMessagesRequest):
    Operation<MessageAnalysis, AnalyzeMessagesMetadata>;
  @get("/{id=operations/*}")
  GetOperation<ResultT, MetadataT>(req: GetOperationRequest):
    Operation<ResultT, MetadataT>;
  @get("/operations")
  ListOperations<ResultT, MetadataT>(req: ListOperationsRequest):
    ListOperationsResponse<ResultT, MetadataT>;
  @get("/{id=operations/*}:wait")
  WaitOperation<ResultT, MetadataT>(req: WaitOperationRequest):
    Operation<ResultT, MetadataT>;
  @