解决openapi-typescript中自签名证书问题的技术方案

问题背景

在使用openapi-typescript工具从HTTPS端点生成TypeScript类型定义时，如果目标API使用自签名证书，会遇到DEPTH_ZERO_SELF_SIGNED_CERT错误。这种情况常见于开发环境中使用自签名证书的情况。

错误分析

该错误是由于Node.js默认的安全策略导致的，它会拒绝任何自签名证书的连接。错误信息表明系统无法验证证书链，因为证书是自签名的。

解决方案

临时禁用证书验证

在开发环境中，可以通过设置NODE_TLS_REJECT_UNAUTHORIZED环境变量为0来临时禁用证书验证：

export NODE_TLS_REJECT_UNAUTHORIZED=0
openapi-typescript https://your-api-url -o output.d.ts

Windows系统注意事项

在Windows系统中，如果通过shell脚本运行，需要使用正确的语法：

# 在.sh脚本中使用export
export NODE_TLS_REJECT_UNAUTHORIZED=0

自动化脚本示例

可以创建一个自动化脚本来简化这个过程：

#!/bin/sh

# 从.env文件中读取API URL
API_URL=$(dotenv -p PUBLIC_API_URL)

if [ -z "$API_URL" ]; then
 echo "请确保.env文件中配置了PUBLIC_API_URL"
 exit 1
fi

echo "⚠️ 注意：临时禁用TLS证书验证"
export NODE_TLS_REJECT_UNAUTHORIZED=0

# 生成类型定义
openapi-typescript $API_URL -o src/lib/types/openapi.d.ts

安全注意事项

1. 此解决方案仅适用于开发环境
2. 生产环境中应使用有效的CA签名证书
3. 禁用证书验证会使连接容易受到中间人攻击
4. 建议在完成类型生成后立即恢复默认设置

替代方案

对于长期解决方案，可以考虑：

1. 将自签名证书添加到系统的信任存储
2. 使用有效的CA签名证书（如Let's Encrypt）
3. 在开发环境中使用HTTP协议（但注意现代浏览器对某些功能如地理定位的限制）

总结

通过临时禁用Node.js的TLS证书验证，可以解决openapi-typescript在开发环境中处理自签名证书API的问题。这种方法简单有效，但需要注意安全风险，仅限开发环境使用。