[网络协议]手把手教你使用swagger进行http测试

在上一节中，我们通过grpc-gateway提供了http服务，最后使用的是postman进行通信测试，当我们有大量服务的时候，这种方式会非常繁琐，所以这节我们通过swagger来进行通信测试

1. 安装swagger程序，然后下载swagger示例代码，网址 GitHub - swaggo/swag: Automatically generate RESTful API documentation with Swagger 2.0 for Go.

2. 进入路径：/swag-master/example/object-map-example，更改main.go代码，

package main

import (
	"github.com/gin-gonic/gin"
	"github.com/swaggo/swag/example/object-map-example/controller"
	_ "github.com/swaggo/swag/example/object-map-example/docs"

	swaggerFiles "github.com/swaggo/files"
	ginSwagger "github.com/swaggo/gin-swagger"
)

// @title Swagger Map Example API
// @version 1.0
// @termsOfService http://swagger.io/terms/

// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html

// @host 192.168.xx.xxx:8081
// @BasePath /v1
func main() {
	r := gin.Default()

	c := controller.NewController()

	v1 := r.Group("/v1")
	{
		test := v1.Group("/map")
		{
			test.GET("", c.GetMap)
		}
	}
	r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
	r.Run(":8090")
}

3. 更改/swag-master/example/object-map-example/controller/api.go代码文件；

// VGetMaI godoc
// @Summary Get Map Example
// @Description get map
// @ID get-map
// @Accept json
// @Produce json
// @Param data body TOperInvestormargin true "body"
// @Success 200 {object} Response
// @Router /example/InsertTOperInvestormargin [post]
func (c *Controller) GetMap(ctx *gin.Context) {
	ctx.JSON(200, Response{
		Title: map[string]string{
			"en": "Map",
		},
		CustomType: map[string]interface{}{
			"key": "value",
		},
		Object: Data{
			Text: "object text",
		},
	})
}

4 运行命令 swag init，再运行go build进行编译，最后运行./object-map-example启动swagger服务；

5. 在浏览器中输入 ?192.168.xx.xxx:8090/swagger/index.html? ??；

?6. 点击try out，再点击execute，最终执行成功；

?7. 如果需要传输数据，则要在/swag-master/example/object-map-example/controller/api.go文件中添加对应的结构体；

8. 如果在执行过程中报错：TypeError: Failed to fetch，按F12后报错No 'Access-Control-Allow-Origin' header is present on the requested resource，则需要打开windows中的运行，然后运行命令chrome.exe --user-data-dir="C:/Chrome dev session" --disable-web-security，这里使用的是chrome浏览器，如果使用的是其它浏览器可以参考运行，然后会重新打开一个chrome浏览器，再次运行? 192.168.xx.xxx:8090/swagger/index.html? 即可正常；