Golang Gin 项目使用 Swagger

Golang Gin 项目使用 Swagger

标签(空格分隔): Go



首先需要github.com/swaggo/gin-swaggergithub.com/swaggo/gin-swagger/swaggerFiles(参见gin-swagger)。

然后根据 github.com/swaggo/swag/cmd/swag文档获取到swag工具;执行swag init在项目根目录下生成docs文件夹。然后在路由中import _ "/docs"。这时候编译程序,打开http://localhost:8080/swagger/index.html就可以看到API。有时候打开页面js报错,多刷新几次就有了(原因未知)。

注意项目目录下,包依赖不能用src等名称,请看以下源码:

//exclude vendor folder
if ext := filepath.Ext(path); ext == ".go" &&
    !strings.Contains(string(os.PathSeparator)+path, string(os.PathSeparator)+"vendor"+string(os.PathSeparator)) &&
    !strings.Contains(string(os.PathSeparator)+path, string(os.PathSeparator)+".history"+string(os.PathSeparator)) &&
    !strings.Contains(string(os.PathSeparator)+path, string(os.PathSeparator)+".idea"+string(os.PathSeparator)) &&
    !strings.Contains(string(os.PathSeparator)+path, string(os.PathSeparator)+".git"+string(os.PathSeparator)) {
    fset := token.NewFileSet() // positions are relative to fset
    astFile, err := goparser.ParseFile(fset, path, nil, goparser.ParseComments)

swag工具排除了vendor.history.idea.git目录下的文件(参见pl)。可以使用godep等工具将依赖包放在vendor目录下。

原文地址:https://www.cnblogs.com/jehorn/p/9809751.html

时间: 2024-11-10 15:31:23

Golang Gin 项目使用 Swagger的相关文章

Golang Gin 项目包依赖管理 godep 使用

Golang Gin 项目包依赖管理 godep 使用 标签(空格分隔): Go 在按照github.com/tools/godep文档go get完包以后,调整项目结构为$GOPATH/src/$PROJECT_NAME/,同时使项目编译没有问题.执行godep save命令,出现了一系列包缺失的问题: github.com/campoy/embedmd github.com/client9/misspell/cmd/misspell github.com/dustin/go-broadcas

golang gin框架 使用swagger生成api文档

github地址:https://github.com/swaggo/gin-swagger 1.下载swag $ go get -u github.com/swaggo/swag/cmd/swag 2.在main.go所在目录执行 $ swag init 生成docs/doc.go以及docs/swagger.json,docs/swagger.yaml 3.下载gin-swagger $ go get -u github.com/swaggo/gin-swagger $ go get -u

Golang Gin/Ace/Iris/Echo RBAC 鉴权库

GRBAC 项目地址: https://github.com/storyicon/grbac Grbac是一个快速,优雅和简洁的RBAC框架.它支持增强的通配符并使用Radix树匹配HTTP请求.令人惊奇的是,您可以在任何现有的数据库和数据结构中轻松使用它. grbac的作用是确保指定的资源只能由指定的角色访问.请注意,grbac不负责存储鉴权规则和分辨"当前请求发起者具有哪些角色",更不负责角色的创建.分配等.这意味着您应该首先配置规则信息,并提供每个请求的发起者具有的角色. grb

【招募】golang小项目

最近想用golang写一个小项目: 语言:golang 目标:学习完golang,必须有小项目练手 招募期限:截止到2017年3月28日 人数:4~5人 内容:对标barbican内容 报名方式:直接私信给我

netcore项目使用swagger开发

首先我创建一个netcore项目,我使用的工具是vs2019 这里需要注意的是,看情况选择是否开启身份验证,一般是没有需求的,这里因为我是测试使用所以需要取消勾兑为https配置,并且我没有启用docker支持,因为这个 项目我只是写接口,所以我创建的是一个webapi项目 点击创建,生成项目 因为要使用swagger,所以我们需要安装指定的组件包,现在我们使用nuget安装组件 安装后我们需要去startup中进行配置 首先我们在ConfigureServices中尽心注册swagger服务

MVC项目集成swagger

1.创建WebAPI项目解决方案 2.使用nuget引入Swashbuckle包 引入Swashbuckle包后App_Start文件夹下会多出一个SwaggerConfig文件 3.添加接口注释 项目属性->生成,勾选生成xml文档文件(有些太古老的WebSite项目不支持注释功能,因为根本没有生成xml这一个选项) 生成xml文档后在SwaggerConfig文件里加入配置 var xmlAPI = $@"{AppDomain.CurrentDomain.BaseDirectory}\

依赖注入 gin项目的目录结构说明

前言 依赖注入的好处和特点这里不讲述了,本篇文章主要介绍gin框架如何实现依赖注入,将项目解耦. 项目结构 ├── cmd 程序入口 ├── common 通用模块代码 ├── config 配置文件 ├── controller API控制器 ├── docs 数据库文件 ├── models 数据表实体 ├── page 页面数据返回实体 ├── repository 数据访问层 ├── router 路由 ├── service 业务逻辑层 ├── vue-admin Vue前端页面代码

Go语言(golang)开源项目大全

转http://www.open-open.com/lib/view/open1396063913278.html内容目录Astronomy构建工具缓存云计算命令行选项解析器命令行工具压缩配置文件解析器控制台用户界面加密数据处理数据结构数据库和存储开发工具分布式/网格计算文档编辑器Encodings and Character SetsGamesGISGo ImplementationsGraphics and AudioGUIs and Widget ToolkitsHardwareLangu

【Network】golang 容器项目 flannel/UDP相关资料

参考资料: flannel_百度搜索 Flannel首页.文档和下载 - 容器集群子网 - 开源中国社区 docker下基于flannel的overlay网络分析 - OPEN 开发经验库 flannel/common.go at master · coreos/flannel flannel/kube-flannel.yml at master · coreos/flannel 为什么隧道封装是Docker多数网络项目的共同选择-中国学网-中国IT综合门户网站-提供健康,养生,留学,移民,创业