如何解决如何在Cloud函数中提供诸如swagger ui之类的静态文件
如何通过Go在Cloud Function中提供swagger-ui-dist?
我要在“云功能”环境之外进行操作:
package main
import (
"fmt"
"net/http"
)
func main() {
fs := http.FileServer(http.Dir("./swagger-ui-dist"))
http.Handle("/swaggerui/",http.StripPrefix("/swaggerui/",fs))
http.ListenAndServe(":8080",nil)
}
但是由于Cloud函数使用标准的http.HanlderFunc接口将常规函数用作处理程序,所以我不知道如何使它起作用。
我尝试模拟这种情况以使用http.ServeFile进行测试,但是没有用。似乎没有下载该文件夹的所有内容。
package main
import (
"fmt"
"net/http"
)
func cloudFunctionHandler(w http.ResponseWriter,r *http.Request) {
http.ServeFile(w,r,"./swagger-ui-dist")
}
func main() {
http.HanldeFunc("/swaggerui/",handler)
http.ListenAndServe(":8080",nil)
}
解决方法
我尝试了多种方法,它在本地工作时具有与Cloud Function(相同的函数签名)相同的行为,但是在Cloud Functions上部署后却无法工作。
我明白为什么。实际上Buildpack (the tools develped by Google for building a container without a Dockerfile,and now in the CNCF sandbox)会编译.go文件,并将二进制文件复制到最终容器层。其他所有文件/目录均被省略。因此,它行不通!
我建议您使用Cloud Run(与Cloud Functions相同的基础平台,在某些情况下更便宜。我wrote an article on this)
另一种解决方案是使用未编译的语言,例如NodeJS或Python。
,实际上可以通过三种方式(我知道):
- 从 CDN 提供静态文件。例如。来自http://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.40.0/
- 自己在不同的端点上托管静态文件
- 将静态文件添加到您的云函数的根文件夹中。这些将与您的代码打包在一起,因此在部署时可用
(我选择了选项 3)
对于选项 2 和 3,您必须覆盖 swaggerui 用于其静态资产的文件夹。您如何执行此操作取决于您如何配置 swagger ui。
就我而言,我使用了flask_restx Python 包来生成swagger.json
并提供swaggerui。所以我像这样打补丁:
from flask_restx.apidoc import apidoc
apidoc.static_folder = '<MY STATIC FOLDER PATH' # e.g. os.path.abspath('static/swaggerui')
此外,您需要在运行 gcloud function deploy ...
之前将文件从 swaggerui 库复制到函数的根目录。
我在 CI 管道期间将 static
文件夹从flask_restx 复制到函数的根目录。
希望对大家有所帮助!