主页 / coding / 问题 / 78825482
Accepted
SamDroid
Asked: 2024-08-02 20:23:28 +0800 CST

Fastify Swagger 未按预期管理枚举器

  • 772

我们正在使用Fastify开发后端，使用Typebox声明模式并使用Fastify Swagger生成 OpenApi 定义 我们在生成文档期间遇到了一些枚举或类似问题

假设我们以下列方式之一声明一个类型框枚举器

export const ProviderType = Type.Union([
  Type.Literal("sms"),
  Type.Literal("email"),
]);

//OR

enum Providers {
  SMS = "sms",
  EMAIL = "email",
}

export const ProviderType = Type.Enum(Providers);

当生成开放 API 文档时，我们得到这个

- schema:
    anyOf:
        - type: string
          enum:
              - sms
        - type: string
          enum:
              - email

这不是我们所期望的，而是

schema:
    type: string
    enum: [sms, email]

否则，各个包将无法正确呈现使用枚举的地方。

你已经遇到过这个问题了吗？

openapi

1 个回答

  1. Best Answer

    正如首席维护者enum所说，TypeBox 项目不支持ATM 。

    它提出了一种解决方法：

    const StringEnum = <T extends string[]>(items: [...T]) =>
  Type.Unsafe<T[number]>({ type: "string", enum: items });

export const ProviderType = StringEnum(["email", "sms"]);

// BECOMES
 - schema:
            type: string
            enum:
              - email
              - sms

    因此fastify-swagger将使用enum关键字。

    • 3

相关问题