Golang 项目如何生成 swagger 文档

最新推荐文章于 2024-05-24 10:34:08 发布
最新推荐文章于 2024-05-24 10:34:08 发布
阅读量695 收藏 9
点赞数 6
分类专栏： 最佳实践 工具 文章标签： golang 开发语言 后端
好好学习天天向上
本文链接：https://blog.csdn.net/weixin_37646636/article/details/135350254
版权

swag工具介绍和安装

Swag是一款可以将Go的注释转换为Swagger2.0格式文档的工具，生成接口文档用到的注释需要按照swag要求的格式书写。

使用 笔者用过的方案

第1步：GoLand by JetBrains 里 Alt+F12 调出控制台

第2步：使用go install方式下载安装swag

go install github.com/swaggo/swag/cmd/swag@latest

第3步：在包含main.go文件的项目根目录运行swag init

swag init

参考

Golang项目自动生成swagger格式接口文档方法（一）
Golang项目自动生成swagger格式接口文档方法（二）

张紫娃
关注
  • 6
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
使用Swagger自动生成接口文档
duhuahuaya的博客
03-24 3633
安装swagger 链接: link 1.打开vscode，在终端输入： npm install --save @nestjs/swagger swagger-ui-express 应用swagger 1.打开入口文件main.ts，在引用里面加入 import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger'; 2.打开入口文件main.ts，在引用里面加入 const config = new DocumentBuilder()
golang-swaggerui-example:Golang的SwaggerUI生成示例
05-14
Golang-swaggerui-example是一个示例存储库，用于在您的Golang项目中使用SwaggerUI设置API文档。 详细说明可在。 API互动 可以通过访问localhost：8080 / swaggerui /访问SwaggerUI，有关如何服务/ swaggerui的详细...
简单易懂： Go 自动生成 Swagger API 文档教程
py0007的博客
03-29 795
作为 Go 语言中支持 Swagger 2.0 和 OpenAPI 3.0 规范的工具之一，go-swagger 主要用于快速构建、记录并测试 RESTful API。允许开发者自动化生成客户端和服务端代码，极大地提高了开发效率和接口的标准化。
Golang项目自动生成swagger格式接口文档方法（一）
路多辛的所思所想
03-02 715
Swag是一款可以将Go的注释转换为Swagger2.0格式文档的工具，生成接口文档用到的注释需要按照swag要求的格式书写。请求URI query里数组参数的默认格式：csv，multi，pipes，tsv，ssv。以空格分隔的头字段。API可以生成的MIME类型的列表。API可以生成的MIME类型的列表。用于API的许可证的URL。
golang windows环境下集成swag的步骤
最新发布
fang0604631023的博客
05-24 396
golang windows环境下集成swag的步骤
一个在Go中生成swagger文档的思路
林锦佳的博客
03-22 1481
文章首发于个人博客，欢迎访问关注：https://www.lin2j.tech 项目源代码在 Github 上：https://github.com/lin2j/iris-swagger-gen 下载 protoc 相关的工具 安装 protoc 工具 https://github.com/protocolbuffers/protobuf/releases 将解压后的exe文件放到 $GOPATH/bin 目录下即可 安装protobuf库文件 go get github.com/golang/proto
Golang使用Swagger文档教程
12-04 1412
其次，想要生成swagger文档也非常简单，然后，为swagger注册gin路由。简单介绍一下Swagger的使用。首先导入swagger相关的包。
go生成Swagger在线文档
qq_51537858的博客
06-10 513
·如何给 API 添加 Swagger 文档功能 ·如何编写 API 文档第一步添加注释 3、4、5、 第三步：引入gin-swagger渲染文档数据 第四步：查看Swagger 2.0 Api文档
【Golang学习笔记】swagger自动化api文档生成
FixPng的博客
02-21 517
参照b站大佬的教程视频，golang-swagger自动化api文档生成，从安装到demo跑起来图文全过程。
swagger在线文档转成word文档
09-27
本篇文章将详细讲解如何在SpringBoot项目中利用Swagger生成的在线文档转换成Word文档。 首先，我们需要在SpringBoot项目中集成Swagger2。Swagger2提供了一个简洁的方式来定义和文档化RESTful APIs。通过添加`...
swag:使用Swagger 2.0 for Go自动生成RESTful API文档
04-28
Swag将Go注释转换为Swagger文档2.0。 我们已经为流行的创建了各种插件。 这使您可以快速与现有Go项目集成（使用Swagger UI）。 内容 支持的Web框架 如何与杜松子酒一起使用 实施状况 声明式注释格式 常规API信息 ...
Swagger 2.0实现-Golang开发
05-26
此软件包包含Swagger 2.0（又称OpenAPI 2.0）的golang实现：它知道如何序列化和反序列化Swagger规范。 Swagger是RESTful API的简单但功能强大的表示形式。 简而言之，Swagger拥有全球最大的API工具生态系统，...
fiber-swagger:光纤中间件可通过Swagger 2.0自动生成RESTful API文档
05-15
光纤中间件，以使用Swagger 2.0自动生成RESTful API文档。 用法 开始使用它 将注释添加到您的API源代码中，。 使用以下方法下载 for Go： $ go get -u github.com/swaggo/swag/cmd/swag 在包含main.go文件的Go项目...
Go 项目自动生成接口文档
许盛的博客
01-27 2633
背景 如何让后端同学愉快地写接口文档，是个老大难问题。 使用 GraphQL 当接口标准，倒是省了接口文档的问题，连前端代码都可以自动生成了，但是对后端同学来说，学习成本又比较大。 使用 gRPC 当接口标准，后端同学是爽了，但是前端的 gPRC 相关生态和工具是真的烂，体验极差。 有段时间尝试搞了个前端 BFF 层，把 gPRC 接口转换为 GraphQL 接口供前端调用，听起来很美好，但是却额外多了一个需要维护的项目，工作量陡增，接口出现问题时排查也变麻烦了。 后来还是选择在 yapi接口平台上人工维
GO 接口详解
baidu_41917849的博客
02-25 2513
在go语言中，接口是一种就是一种类型。同map、struct等的定义，语法是一样。 如： type People interface { Speak(string) string } 关键字是interface。此时就称People是一个接口。 接口的作用就是定义一些对象的共同特征，特征以接口内的方法来定义。如上例的speak方法。 具有上述特征的类型，那就称它实现了这个接口。语法如下： // 定义类型Student，它是一种struct类型 type Student struct{}
swaggo无法生成swagger.json
jiuweiC的博客
05-28 1024
swaggo无法生成swagger.json swaggo 的包管理还不支持gomod，也就是说需要gopath 解决方案 export GOPATH=/Users/anker/Documents/go_work //设置gopath export GO111MODULE=off //关闭gomod开关 swaggo -s ./main.go -o ./conf
GO 的 Web 开发系列（五）—— 使用 Swagger 生成一份好看的接口文档
玖涯博客
02-12 1978
经过前面的文章，已经完成了 Web 系统基础功能的搭建，也实现了 API 接口、HTML 模板渲染等功能。接下来要做的就是使用 Swagger 工具，为这些 Api 接口生成一份好看的接口文档。
使用Swagger生成 API 文档(go语言示例)
kuokay的博客
06-12 6311
Swagger 是一套围绕 OpenAPI 规范构建的开源工具，可以设计、构建、编写和使用REST API。Swagger 包含很多工具，其中主要的 Swagger 工具包括：OpenAPI 是一个 API 规范，它的前身叫 Swagger 规范，通过定义一种用来描述 API 格式或 API 定义的语言，来规范 RESTful 服务开发过程，目前最新的 OpenAPI 规范是OpenAPI 3.0（也就是 Swagger 2.0 规范）。OpenAPI 规范规定了一个 API 必须包含的基本信息，这些信息包
golang 如何生成word文档
07-15
要在Golang中生成Word文档，你可以使用第三方库`github.com/360EntSecGroup-Skylar/excelize`。尽管该库的名称是`excelize`，但它也支持生成和操作Word文档。下面是一个简单的示例代码： ```go package main import ( "fmt" "github.com/360EntSecGroup-Skylar/excelize/v2" ) func main() { f := excelize.NewFile() // 创建一个新的Sheet index := f.NewSheet("Sheet1") // 设置单元格的值 f.SetCellValue("Sheet1", "A1", "Hello") f.SetCellValue("Sheet1", "B1", "World!") // 保存文件 err := f.SaveAs("output.xlsx") if err != nil { fmt.Println(err) return } fmt.Println("Word文档生成成功！") } ``` 在上面的示例中，我们使用`excelize`库创建了一个新的Excel文件，并在Sheet中设置了单元格的值。请注意，生成的文件格式是xlsx，但它也可以在Microsoft Word中打开并另存为Word文档（.docx）格式。 你需要使用以下命令安装`excelize`库： ``` go get github.com/360EntSecGroup-Skylar/excelize/v2 ``` 请确保你已经安装了Go语言的开发环境并配置好了GOPATH。 希望这可以帮助到你生成Word文档！

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值