简述 Gin 框架如何集成swagger

本文档详细介绍了如何在Gin框架中集成Swagger,包括安装Swagger工具,添加依赖包,编写示例程序,并手动指定路由以生成API文档,最后通过执行命令展示Swagger UI。
摘要由CSDN通过智能技术生成

简述Gin框架集成swagger过程

1、安装 swag
go get github.com/swaggo/swag/cmd/swag

swag 用于生成 docs 文件夹(swagger文档程序使用)

安装完成后会在 ${GOPATH}/bin生成一个执行文件

2、安装依赖包
github.com/gin-gonic/gin
github.com/swaggo/gin-swagger
3、示例程序

/**
 * Created by martin on 01/02/2019
 */

package main

import (
	_ "./docs"
	"github.com/gin-gonic/gin"
	"github.com/swaggo/gin-swagger"
	"github.com/swaggo/gin-swagger/swaggerFiles"
	"net/http"
)

// @title 测试
// @version 0.0.1
// @description  测试
// @BasePath /api/v1/
func main() {
	r := gin.New()

	// 创建路由组
	v1 := r.Group("/api/v1")

	v1.GET("/record/:userId",record)

	// 文档界面访问URL
	// http://127.0.0.1:8080/swagger/index.html
	r.GET("/swagger/*any"
  • 2
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值