Golang gin 实现简单的 https 加 swagger 功能

待我称王封你为后i 2023-10-13 16:51 7阅读 0赞

#### 阅读目录 ####

*  Golang gin 实现简单的 https 加 swagger 功能
 *   *  1 先安装swag可执行文件插件
     *  2 初始化项目
     *  3 定义gin的swagger实现方法
     *  4 自创建测试环境下https证书
     *  5 初始化

## Golang gin 实现简单的 https 加 swagger 功能 ##

![在这里插入图片描述][9bd385a7357f431c8215ec843499454e.png]

https://127.0.0.1:8080/swagger/index.html#/

// golang实现的gin+swagger
    // 初始化项目
    // go mod init ginSwagger
    // go mod tidy
    // 安装swag命令插件，用于执行swag命令
    // go get github.com/swaggo/swag/cmd/swag
    // go install github.com/swaggo/swag/cmd/swag
    // swag init --parseDependency --parseInternal
    package main
    
    import (
    	"crypto/rand"
    	"crypto/rsa"
    	"crypto/x509"
    	"crypto/x509/pkix"
    	"encoding/pem"
    	"fmt"
    	"math/big"
    	"net"
    	"net/http"
    	"os"
    	"time"
    
    	_ "test/docs"
    
    	"github.com/gin-gonic/gin"
    	swaggerFiles "github.com/swaggo/files"
    	ginSwagger "github.com/swaggo/gin-swagger"
    )
    
    type GwResponse struct {
        
    	Code    uint32      `json:"code"`
    	Message uint32      `json:"message" description:"描述"`
    	Data    interface{
        } `json:"data"`
    }
    
    type GwRequest struct {
        
    	Code    uint32      `json:"code"`
    	Message uint32      `json:"message"`
    	Data    interface{
        } `json:"data"`
    }
    
    type GwResponseError struct {
        
    	Code    uint32      `json:"code"`
    	Message uint32      `json:"message" description:"描述"`
    	Data    interface{
        } `json:"data"`
    }
    
    func main() {
        
    	// 生成证书
    	ip := "127.0.0.1"
    	alternateDNS := []string{
        "localhost"}
    	GenerateSelfSignedCertKey(2048, ip, []net.IP{
        net.ParseIP(ip)}, alternateDNS)
    
    	// 注册swagger路由
    	router := gin.Default()
    	swagAny := func(c *gin.Context) {
         ginSwagger.DisablingWrapHandler(swaggerFiles.Handler, "SWAGGER")(c) }
    	router.GET("/swagger/*any", swagAny)
    
    	// 注册gin方法
    	router.GET("/ping", func(c *gin.Context) {
        
    		c.JSON(200, gin.H{
        "message": "pong"})
    	})
    	router.GET("/get", Get)
    	router.POST("/post", Post)
    
    	// 开启gin的https,如果是http使用router.Run()
    	server := &http.Server{
        Addr: ip + ":8080", Handler: router}
    	_ = server.ListenAndServeTLS(ip+".crt", ip+".key")
    
    }
    
    // @Summary  GET请求的例子
    // @Schemes
    // @Description  GET请求的例子描述
    // @Tags         请求例子
    // @Param        id  query  int  true  "Account ID"
    // @Accept       json
    // @Produce      json
    // @Success      200  {object}  GwResponse
    // @Router       /get [get]
    func Get(c *gin.Context) {
        
    	id := c.Query("id")
    	fmt.Println(id)
    	res := GwResponse{
        Code: 1001, Message: 1, Data: id + ";connect success !!!"}
    	c.JSON(http.StatusOK, res)
    }
    
    // @Summary      POST请求的例子
    // @Description  POST请求的例子描述
    // @Tags         请求例子
    // @Param        body  body  GwRequest  true  "JSON数据"
    // @Accept       json
    // @Produce      json
    // @Success      200  {object}  GwResponse         "成功后返回数据结构"
    // @Failure      400  {object}  GwResponseError    "失败后返回数据结构"
    // @Router       /post [post]
    func Post(c *gin.Context) {
        
    	var req GwRequest
    	if err := c.BindJSON(&req); err != nil {
        
    		fmt.Println(err)
    	} else {
        
    		fmt.Println(req)
    	}
    
    	res := GwResponse{
        Code: 1001, Message: 1, Data: req.Data.(string) + ";connect success !!!"}
    	c.JSON(http.StatusOK, res)
    }
    
    // 生成证书
    func GenerateSelfSignedCertKey(keySize int, host string, alternateIPs []net.IP, alternateDNS []string) {
        
    	// 生成密钥对d
    	priv, err := rsa.GenerateKey(rand.Reader, keySize)
    	if err != nil {
        
    		panic(err)
    	}
    	// 创建证书模板
    	template := x509.Certificate{
        
    		SerialNumber: big.NewInt(1), // 该号码表示CA颁发的唯一序列号，在此使用一个数来代表
    		Issuer:       pkix.Name{
        },
    		Subject:      pkix.Name{
        CommonName: fmt.Sprintf("%s@%d", host, time.Now().Unix())},
    		NotBefore:    time.Now(),
    		NotAfter:     time.Now().Add(time.Hour * 24 * 365),
    		KeyUsage:     x509.KeyUsageKeyEncipherment | x509.KeyUsageDigitalSignature | x509.KeyUsageCertSign, // 表示该证书是用来做服务端认证的
    		ExtKeyUsage:  []x509.ExtKeyUsage{
        x509.ExtKeyUsageServerAuth},
    	}
    
    	if ip := net.ParseIP(host); ip != nil {
        
    		template.IPAddresses = append(template.IPAddresses, ip)
    	} else {
        
    		template.DNSNames = append(template.DNSNames, host)
    	}
    
    	template.IPAddresses = append(template.IPAddresses, alternateIPs...)
    	template.DNSNames = append(template.DNSNames, alternateDNS...)
    
    	// 创建证书,这里第二个参数和第三个参数相同则表示该证书为自签证书，返回值为DER编码的证书
    	certificate, err := x509.CreateCertificate(rand.Reader, &template, &template, &priv.PublicKey, priv)
    	if err != nil {
        
    		panic(err)
    	}
    	// 将得到的证书放入pem.Block结构体中
    	block := pem.Block{
        
    		Type:    "CERTIFICATE",
    		Headers: nil,
    		Bytes:   certificate,
    	}
    	// 通过pem编码并写入磁盘文件
    	file, err := os.Create(host + ".crt")
    	if err != nil {
        
    		panic(err)
    	}
    	defer file.Close()
    	pem.Encode(file, &block)
    
    	// 将私钥中的密钥对放入pem.Block结构体中
    	block = pem.Block{
        
    		Type:    "RSA PRIVATE KEY",
    		Headers: nil,
    		Bytes:   x509.MarshalPKCS1PrivateKey(priv),
    	}
    	// 通过pem编码并写入磁盘文件
    	file, err = os.Create(host + ".key")
    	if err != nil {
        
    		panic(err)
    	}
    	pem.Encode(file, &block)
    }

### 1 先安装swag可执行文件插件 ###

go get github.com/swaggo/swag/cmd/swag
    go install github.com/swaggo/swag/cmd/swag

### 2 初始化项目 ###

go mod init ginSwagger
    go mod tidy

### 3 定义gin的swagger实现方法 ###

type GwResponse struct {
    	Code    uint32      `json:"code"`
    	Message uint32      `json:"message" description:"描述"`
    	Data    interface{} `json:"data"`
    }
    
    
    
    // @Summary  GET请求的例子
    // @Schemes
    // @Description  GET请求的例子描述
    // @Tags         请求例子
    // @Param        id  query  int  true  "Account ID"
    // @Accept       json
    // @Produce      json
    // @Success      200  {object}  GwResponse
    // @Router       /get [get]
    func Get(c *gin.Context) {
    	id := c.Query("id")
    	fmt.Println(id)
    	res := GwResponse{Code: 1001, Message: 1, Data: id + ";connect success !!!"}
    	c.JSON(http.StatusOK, res)
    }

### 4 自创建测试环境下https证书 ###

// 生成证书
    ip := "127.0.0.1"
    alternateDNS := []string{"localhost"}
    GenerateSelfSignedCertKey(2048, ip, []net.IP{net.ParseIP(ip)}, alternateDNS)

### 5 初始化 ###

swag init --parseDependency --parseInternal

swag init --parseDependency --parseInternal 是在执行 swag init 命令时使用的一些选项参数。

–parseDependency：该选项告诉 Swag 工具在生成文档时解析项目依赖项。这样可以包括项目中使用的其他包或模块的API文档信息，使生成的文档更完整和准确。

–parseInternal：该选项告诉 Swag 工具在生成文档时解析项目内部的代码。这样可以包括项目内部的结构、函数和注释等信息，使生成的文档更详细和全面。

使用这两个选项参数可以确保生成的 Swagger 文档包含项目中所有相关的 API 信息，无论是项目自身的代码还是项目依赖的其他包或模块。

在您的代码示例中，swag init --parseDependency --parseInternal 命令被用来生成 Swagger 文档所需的相关代码文件。通过使用这些选项参数，Swag 工具将解析项目的依赖关系和内部代码，生成包含完整 API 信息的文档文件。这样，您就可以使用 Swagger UI 或其他 Swagger 相关工具来浏览和查看生成的 API 文档。

[9bd385a7357f431c8215ec843499454e.png]: https://img-blog.csdnimg.cn/9bd385a7357f431c8215ec843499454e.png