Swift OpenAPI Generator 中如何控制生成代码的访问权限

在 Swift 项目中，当我们使用 OpenAPI Generator 自动生成客户端代码时，经常会遇到生成的类型默认是 internal 访问级别的问题。这会导致在测试模块中无法直接使用这些类型，给测试工作带来不便。

问题背景

OpenAPI Generator 生成的代码默认使用 internal 访问修饰符，这意味着生成的类型只能在定义它们的模块内部使用。当我们需要在测试模块中使用这些类型时，就会遇到访问权限不足的问题。

解决方案

OpenAPI Generator 提供了 accessModifier 配置选项，允许开发者自定义生成代码的访问级别。这个选项支持三种值：

1. public：生成的 API 可以被其他模块和其他包访问
2. package：生成的 API 可以在同一个包或项目中的其他模块间访问
3. internal（默认值）：生成的 API 只能在定义它的模块内访问

配置示例

要解决测试模块访问生成类型的问题，可以在 OpenAPI Generator 的配置文件中添加 accessModifier 设置：

generate:
  - types
  - client
accessModifier: public

或者，如果只需要在同一个包内共享访问权限，可以使用更安全的 package 选项：

generate:
  - types
  - client
accessModifier: package

其他可选方案

除了修改生成代码的访问级别外，还有以下替代方案：

1. 使用 @testable import：在测试文件中使用 @testable import 可以访问目标模块的 internal 成员，但这种方法需要在测试代码中添加额外的注解。

2. 类型别名：虽然直接创建 public 类型别名不可行（因为底层类型是 internal），但可以通过在原始模块中定义 public 包装类型来间接实现。

最佳实践建议

1. 优先考虑使用 package 而非 public，除非确实需要将类型暴露给外部包使用。

2. 对于仅用于测试的场景，@testable import 可能是更合适的选择，因为它不会影响生产代码的访问控制。

3. 在设计 API 时，考虑哪些类型确实需要被测试模块访问，避免过度暴露实现细节。

通过合理配置 OpenAPI Generator 的访问控制选项，可以灵活地平衡代码封装性和测试便利性，为 Swift 项目开发提供更好的支持。