Swagger了解一下

在上一节，我们完成了一个服务端同时支持Rpc和RESTful Api后，你以为自己大功告成了，结果突然发现要写Api文档和前端同事对接= = 。。。

你寻思有没有什么组件能够自动化生成Api文档来解决这个问题，就在这时你发现了Swagger，一起了解一下吧！

介绍

Swagger

Swagger是全球最大的OpenAPI规范（OAS）API开发工具框架，支持从设计和文档到测试和部署的整个API生命周期的开发

Swagger是目前最受欢迎的RESTful Api文档生成工具之一，主要的原因如下

同时grpc-gateway也支持Swagger

[image]

OpenAPI规范

OpenAPI规范是Linux基金会的一个项目，试图通过定义一种用来描述API格式或API定义的语言，来规范RESTful服务开发过程。OpenAPI规范帮助我们描述一个API的基本信息，比如：

  • 有关该API的一般性描述
  • 可用路径（/资源）
  • 在每个路径上的可用操作（获取/提交…）
  • 每个操作的输入/输出格式

目前V2.0版本的OpenAPI规范（也就是SwaggerV2.0规范）已经发布并开源在github上。该文档写的非常好，结构清晰，方便随时查阅。

注：OpenAPI规范的介绍引用自原文

使用

生成Swagger的说明文件

第一，我们需要检查$GOBIN下是否包含protoc-gen-swagger可执行文件

若不存在则需要执行：

  1. go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger

等待执行完毕后，可在$GOPATH/bin下发现该执行文件，将其移动到$GOBIN下即可

第二，回到$GOPATH/src/grpc-hello-world/proto下，执行命令

  1. protoc -I/usr/local/include -I. -I$GOPATH/src/grpc-hello-world/proto/google/api --swagger_out=logtostderr=true:. ./hello.proto

成功后执行ls即可看到hello.swagger.json文件

下载Swagger UI文件

Swagger提供可视化的API管理平台，就是Swagger UI

我们将其源码下载下来，并将其dist目录下的所有文件拷贝到我们项目中的$GOPATH/src/grpc-hello-world/third_party/swagger-ui去

将Swagger UI转换为Go源代码

在这里我们使用的转换工具是go-bindata

它支持将任何文件转换为可管理的Go源代码。用于将二进制数据嵌入到Go程序中。并且在将文件数据转换为原始字节片之前，可以选择压缩文件数据

安装

  1. go get -u github.com/jteeuwen/go-bindata/...

完成后，将$GOPATH/bin下的go-bindata移动到$GOBIN下

转换

在项目下新建pkg/ui/data/swagger目录，回到$GOPATH/src/grpc-hello-world/third_party/swagger-ui下，执行命令

  1. go-bindata --nocompress -pkg swagger -o pkg/ui/data/swagger/datafile.go third_party/swagger-ui/...

检查

回到pkg/ui/data/swagger目录，检查是否存在datafile.go文件

Swagger UI文件服务器（对外提供服务）

在这一步，我们需要使用与其配套的go-bindata-assetfs

它能够使用go-bindata所生成Swagger UI的Go代码，结合net/http对外提供服务

安装

  1. go get github.com/elazarl/go-bindata-assetfs/...

编写

通过分析，我们得知生成的文件提供了一个assetFS函数，该函数返回一个封装了嵌入文件的http.Filesystem，可以用其来提供一个HTTP服务

那么我们来编写Swagger UI的代码吧，主要是两个部分，一个是swagger.json，另外一个是swagger-ui的响应

serveSwaggerFile

引用包strings、path

  1. func serveSwaggerFile(w http.ResponseWriter, r *http.Request) {
  2.       if ! strings.HasSuffix(r.URL.Path, "swagger.json") {
  3.         log.Printf("Not Found: %s", r.URL.Path)
  4.         http.NotFound(w, r)
  5.         return
  6.     }
  8.     p := strings.TrimPrefix(r.URL.Path, "/swagger/")
  9.     p = path.Join("proto", p)
  11.     log.Printf("Serving swagger-file: %s", p)
  13.     http.ServeFile(w, r, p)
  14. }

在函数中，我们利用r.URL.Path进行路径后缀判断

主要做了对swagger.json的文件访问支持（提供https://127.0.0.1:50052/swagger/hello.swagger.json的访问）

serveSwaggerUI

引用包github.com/elazarl/go-bindata-assetfs、grpc-hello-world/pkg/ui/data/swagger

  1. func serveSwaggerUI(mux *http.ServeMux) {
  2.     fileServer := http.FileServer(&assetfs.AssetFS{
  3.         Asset:    swagger.Asset,
  4.         AssetDir: swagger.AssetDir,
  5.         Prefix:   "third_party/swagger-ui",
  6.     })
  7.     prefix := "/swagger-ui/"
  8.     mux.Handle(prefix, http.StripPrefix(prefix, fileServer))
  9. }

在函数中，我们使用了go-bindata-assetfs来调度先前生成的datafile.go，结合net/http来对外提供swagger-ui的服务

结合

在完成功能后，我们发现path.Join("proto", p)是写死参数的，这样显然不对，我们应该将其导出成外部参数，那么我们来最终改造一番

首先我们在server.go新增包全局变量SwaggerDir，修改cmd/server.go文件：

  1. package cmd
  3. import (
  4.     "log"
  6.     "github.com/spf13/cobra"
  8.     "grpc-hello-world/server"
  9. )
  11. var serverCmd = &cobra.Command{
  12.     Use:   "server",
  13.     Short: "Run the gRPC hello-world server",
  14.     Run: func(cmd *cobra.Command, args []string) {
  15.         defer func() {
  16.             if err := recover(); err != nil {
  17.                 log.Println("Recover error : %v", err)
  18.             }
  19.         }()
  21.         server.Run()
  22.     },
  23. }
  25. func init() {
  26.     serverCmd.Flags().StringVarP(&server.ServerPort, "port", "p", "50052", "server port")
  27.     serverCmd.Flags().StringVarP(&server.CertPemPath, "cert-pem", "", "./conf/certs/server.pem", "cert-pem path")
  28.     serverCmd.Flags().StringVarP(&server.CertKeyPath, "cert-key", "", "./conf/certs/server.key", "cert-key path")
  29.     serverCmd.Flags().StringVarP(&server.CertServerName, "cert-server-name", "", "grpc server name", "server's hostname")
  30.     serverCmd.Flags().StringVarP(&server.SwaggerDir, "swagger-dir", "", "proto", "path to the directory which contains swagger definitions")
  32.     rootCmd.AddCommand(serverCmd)
  33. }

修改path.Join("proto", p)为path.Join(SwaggerDir, p)，这样的话我们swagger.json的文件路径就可以根据外部情况去修改它

最终server.go文件内容：

  1. package server
  3. import (
  4.     "crypto/tls"
  5.     "net"
  6.     "net/http"
  7.     "log"
  8.     "strings"
  9.     "path"
  11.     "golang.org/x/net/context"
  12.     "google.golang.org/grpc"
  13.     "google.golang.org/grpc/credentials"
  14.     "github.com/grpc-ecosystem/grpc-gateway/runtime"
  15.     "github.com/elazarl/go-bindata-assetfs"
  17.     pb "grpc-hello-world/proto"
  18.     "grpc-hello-world/pkg/util"
  19.     "grpc-hello-world/pkg/ui/data/swagger"
  20. )
  22. var (
  23.     ServerPort string
  24.     CertServerName string
  25.     CertPemPath string
  26.     CertKeyPath string
  27.     SwaggerDir string
  28.     EndPoint string
  30.     tlsConfig *tls.Config
  31. )
  33. func Run() (err error) {
  34.     EndPoint = ":" + ServerPort
  35.     tlsConfig = util.GetTLSConfig(CertPemPath, CertKeyPath)
  37.     conn, err := net.Listen("tcp", EndPoint)
  38.     if err != nil {
  39.         log.Printf("TCP Listen err:%v\n", err)
  40.     }
  42.     srv := newServer(conn)
  44.     log.Printf("gRPC and https listen on: %s\n", ServerPort)
  46.     if err = srv.Serve(util.NewTLSListener(conn, tlsConfig)); err != nil {
  47.         log.Printf("ListenAndServe: %v\n", err)
  48.     }
  50.     return err
  51. }
  53. func newServer(conn net.Listener) (*http.Server) {
  54.     grpcServer := newGrpc()
  55.     gwmux, err := newGateway()
  56.     if err != nil {
  57.         panic(err)
  58.     }
  60.     mux := http.NewServeMux()
  61.     mux.Handle("/", gwmux)
  62.     mux.HandleFunc("/swagger/", serveSwaggerFile)
  63.     serveSwaggerUI(mux)
  65.     return &http.Server{
  66.         Addr:      EndPoint,
  67.         Handler:   util.GrpcHandlerFunc(grpcServer, mux),
  68.         TLSConfig: tlsConfig,
  69.     }
  70. }
  72. func newGrpc() *grpc.Server {
  73.     creds, err := credentials.NewServerTLSFromFile(CertPemPath, CertKeyPath)
  74.     if err != nil {
  75.         panic(err)
  76.     }
  78.     opts := []grpc.ServerOption{
  79.         grpc.Creds(creds),
  80.     }
  81.     server := grpc.NewServer(opts...)
  83.     pb.RegisterHelloWorldServer(server, NewHelloService())
  85.     return server
  86. }
  88. func newGateway() (http.Handler, error) {
  89.     ctx := context.Background()
  90.     dcreds, err := credentials.NewClientTLSFromFile(CertPemPath, CertServerName)
  91.     if err != nil {
  92.         return nil, err
  93.     }
  94.     dopts := []grpc.DialOption{grpc.WithTransportCredentials(dcreds)}
  96.     gwmux := runtime.NewServeMux()
  97.     if err := pb.RegisterHelloWorldHandlerFromEndpoint(ctx, gwmux, EndPoint, dopts); err != nil {
  98.         return nil, err
  99.     }
  101.     return gwmux, nil
  102. }
  104. func serveSwaggerFile(w http.ResponseWriter, r *http.Request) {
  105.       if ! strings.HasSuffix(r.URL.Path, "swagger.json") {
  106.         log.Printf("Not Found: %s", r.URL.Path)
  107.         http.NotFound(w, r)
  108.         return
  109.     }
  111.     p := strings.TrimPrefix(r.URL.Path, "/swagger/")
  112.     p = path.Join(SwaggerDir, p)
  114.     log.Printf("Serving swagger-file: %s", p)
  116.     http.ServeFile(w, r, p)
  117. }
  119. func serveSwaggerUI(mux *http.ServeMux) {
  120.     fileServer := http.FileServer(&assetfs.AssetFS{
  121.         Asset:    swagger.Asset,
  122.         AssetDir: swagger.AssetDir,
  123.         Prefix:   "third_party/swagger-ui",
  124.     })
  125.     prefix := "/swagger-ui/"
  126.     mux.Handle(prefix, http.StripPrefix(prefix, fileServer))
  127. }

测试

访问路径https://127.0.0.1:50052/swagger/hello.swagger.json，查看输出内容是否为hello.swagger.json的内容，例如：
[image]

访问路径https://127.0.0.1:50052/swagger-ui/，查看内容
[image]

小结

至此我们这一章节就完毕了，Swagger和其生态圈十分的丰富，有兴趣研究的小伙伴可以到其官网认真研究

而目前完成的程度也满足了日常工作的需求了，可较自动化的生成RESTful Api文档，完成与接口对接

参考

示例代码