能否在Cloud Run环境中生成FastAPI的OpenAPI YAML文件？

以下是几种可行的方案：

• 直接访问内置端点
  FastAPI默认提供/openapi.yaml端点（需确保安装了pyyaml依赖），如果你的Cloud Run服务可直接对外访问，或者API Gateway已配置转发该路径，直接访问https://<your-cloud-run-service-url>/openapi.yaml即可获取YAML文件。
  若使用API Gateway，需在网关的路由规则中添加对/openapi.yaml和/openapi.json的转发配置，允许外部请求访问这些路径。

• 代码内生成并存储到GCS
  可以在FastAPI应用中添加逻辑，启动时或通过内部接口生成OpenAPI YAML并上传到Google Cloud Storage（GCS）：

  from fastapi import FastAPI
  import yaml
  from google.cloud import storage
  
  app = FastAPI()
  
  # 你的API路由定义...
  
  def generate_and_upload_openapi():
      # 生成OpenAPI字典
      openapi_spec = app.openapi()
      # 写入本地文件
      with open("openapi.yaml", "w") as f:
          yaml.dump(openapi_spec, f, sort_keys=False)
      # 上传到GCS
      storage_client = storage.Client()
      bucket = storage_client.bucket("your-gcs-bucket-name")
      blob = bucket.blob("openapi/latest.yaml")
      blob.upload_from_filename("openapi.yaml")
  
  # 应用启动时自动生成
  generate_and_upload_openapi()
  
  # 可选：添加受保护的内部接口触发生成
  @app.get("/internal/generate-openapi")
  async def trigger_openapi_generation():
      generate_and_upload_openapi()
      return {"status": "success", "message": "OpenAPI YAML uploaded to GCS"}
  

  注意需给Cloud Run的服务账号分配GCS对象写入权限，同时在容器镜像中安装pyyaml和google-cloud-storage依赖。

• 通过Cloud Run命令行工具生成
  利用gcloud工具直接在运行中的Cloud Run容器内执行命令，输出OpenAPI YAML到本地：

  # 进入运行中的容器执行生成命令，将结果保存到本地文件
  gcloud run exec <your-service-name> --region <your-region> --command="python -c 'from main import app; import yaml; print(yaml.dump(app.openapi(), sort_keys=False))'" > openapi.yaml
  

  此方法要求你的Cloud Run服务已启用exec权限（默认可能关闭，需在部署时或更新服务时设置--allow-exec），且你有对应的IAM权限执行该操作。

内容的提问来源于stack exchange，提问作者schoon