go集成gin+swagger

1.安装 swag

go get github.com/swaggo/swag/cmd/swag
swag 用于生成 docs 文件夹(swagger文档程序使用)安装完成后会在 ${GOPATH}/bin生成一个执行文件

2.编写代码

/*** Created by liuyusnhengsir on 23/01/2022*/package mainimport (_ "lys_gin_swag/docs""github.com/gin-gonic/gin"ginSwagger "github.com/swaggo/gin-swagger""github.com/swaggo/gin-swagger/swaggerFiles"
)// @title lys_gin_swag微服务api
// @version 0.0.1
// @description  lys_gin_swag微服务 code  by 刘云生
// @BasePath /
func main() {r := gin.New()// 创建路由组v1 := r.Group("/api/v1")v1.GET("/sayHello/:name", sayHello)v2 := r.Group("/api/v2")v2.GET("/sayHello/:name", sayHello2)// 文档界面访问URL// http://127.0.0.1:8080/swagger/index.htmlr.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))r.Run(":8080")
}// @sayHello
// @Description sayHello
// @Accept  json
// @Produce json
// @Param   name     path    string     true        "name"
// @Success 200 {string} string    "name,helloWorld"
// @Router /api/v1/sayHello/{name} [get]
func sayHello(c *gin.Context) {name := c.Param("name")c.JSON(200, gin.H{"describe": "this is /api/v1 ","name":     name,})
}// @sayHello2
// @Description sayHello2
// @Accept  json
// @Produce json
// @Param   name     path    string     true        "name"
// @Success 200 {string} string    "name,helloWorld"
// @Router /api/v2/sayHello/{name} [get]
func sayHello2(c *gin.Context) {name := c.Param("name")c.JSON(200, gin.H{"describe": "this is /api/v2","action":   name,})
}

3.swag init

执行 swag init

4.运行效果

go run main.go

进入 http://127.0.0.1:8080/swagger/index.html 查看文档

go集成gin+swagger相关推荐

Kratos 集成Gin
Kratos 集成 Gin 规范项目分层处理请求处理.响应编写路由route Kratos 集成gin 注入 wire set中源码 Kratos 可以在 .proto文件定义请求类型,URL, ...
密码学【java】初探究之springboo集成mybatis,swagger,数字签名
文章目录项目环境一 swagger技术的补充 1.1 [swagger]((https://github.com/OAI/OpenAPI-Specification))介绍 1.2 swagger ...
推荐这款接口管理神器，集成了Swagger和postman，mock的功能
作为一名开发,日常开发过程中除了写业务代码,前后端联调更是重要的一环.但这一环却往往是整个开发中最繁琐也最累人的一环.任谁都想早点下班,然而提升联调效率并不是个纯技术相关的问题,而是需要有良好工作流程 ...
09｜自研or借力（下）：集成Gin替换已有核心
如何将 Gin 迁移进入我们的框架在 Golang 中,要在一个项目中引入另外一个项目,一般有两种做法,一种做法是把要引用的项目通过 go mod 引入到目标库中,而另外一种做法则费劲的多,使用复制 ...
集成gin 、zap和lumberjack
/*** @author:David Ma* @date:2021-02-01*/package mylogimport ("go.uber.org/zap""go.ub ...
集成Swagger(API)---SpringBoot
集成Swagger(API) 学习目标: 了解Swagger的概念及作用掌握在项目中集成Swagger自动生成API文档 Swagger简介前后端分离前端 -> 前端控制层.视图层后端 ...
Swagger UI 与 Spring Boot 的集成
Swagger UI 用于生成交互式 API 文档,让您可以直接在浏览器中尝试 REST 服务调用. 在本指南中,让我们构建一个简单的 Spring Boot REST 服务并将 Swagger UI ...
SpringBoot——SpringBoot集成Swagger生成API文档
文章目录: 1.写在前面 2.步骤详解 2.1 pom文件中添加Swagger依赖 2.2 在application.properties核心配置文件中配置Swagger 2.3 编写需要生成API文 ...
SpringBoot14：集成Swagger终极版
学习目标: 了解Swagger的概念及作用掌握在项目中集成Swagger自动生成API文档 Swagger简介前后端分离前端 -> 前端控制层.视图层后端 -> 后端控制层.服务层 ...

go集成gin+swagger

1.安装 swag

2.编写代码

3.swag init

4.运行效果

go集成gin+swagger相关推荐

最新文章

热门文章