OpenAPI (Swagger) 规范是否支持架构的通用对象？

Question

我正在研究要在 C# 项目中使用的 OpenAPI 规范。我的 API 使用泛型类型，例如

    class Message<T>
    {
        public string Id { get; set; }
        public T Payload { get; set; }
    }

    class BasicClientState
    {
        public int Count { get; set; }
        public double FaultPercentage { get; set; }
    }

喜欢这个

    class SomeApiController
    {
        public Message<DateTime> GetLatestRebootMessage() 
        {
            throw new NotImplementedException();
        }
        public Message<BasicClientState> GetLatestBasicClientStateMessage()
        {
            throw new NotImplementedException();
        }
    }

这样的泛型能否在 OpenAPI 模式中表示，以便为具有泛型支持的语言（即 Java、TypeScript）生成的 DTO 也具有泛型类型？

Answer 1

是的，但是您将丢失有关这些类的通用来源的信息。

使用 swashbuckle 这是从生成的 swagger.json 中摘录的：

 "DateTimeMessage": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "nullable": true
      },
      "payload": {
        "type": "string",
        "format": "date-time"
      }
    },
    "additionalProperties": false
  },
  "BasicClientState": {
    "type": "object",
    "properties": {
      "count": {
        "type": "integer",
        "format": "int32"
      },
      "faultPercentage": {
        "type": "number",
        "format": "double"
      }
    },
    "additionalProperties": false
  },
  "BasicClientStateMessage": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "nullable": true
      },
      "payload": {
        "$ref": "#/components/schemas/BasicClientState"
      }
    },
    "additionalProperties": false
  }