swaggo: Automatically generate RESTful API documentation with Swagger 2.0 for Go.

// TODO: To be updated…

目录

待更新

1. 快速开始

下载swaggo：

> go get -u github.com/swaggo/swag/cmd/swag

2. swag cli

> swag init -h

NAME:
   swag init - Create docs.go

USAGE:
   swag init [command options] [arguments...]

OPTIONS:
   --generalInfo value, -g value       Go file path in which 'swagger general API Info' is written (default: "main.go")
   --dir value, -d value               Directory you want to parse (default: "./")
   --propertyStrategy value, -p value  Property Naming Strategy like snakecase,camelcase,pascalcase (default: "camelcase")
   --output value, -o value            Output directory for all the generated files(swagger.json, swagger.yaml and doc.go) (default: "./docs")
   --parseVendor                       Parse go files in 'vendor' folder, disabled by default
   --parseDependency                   Parse go files in outside dependency folder, disabled by default

// TODO: To be updated…

参考文章

Github 项目

  1. swaggo/swag - Automatically generate RESTful API documentation with Swagger 2.0 for Go | Github
  2. swaggo/gin-swagger - gin middleware to automatically generate RESTful API documentation with Swagger 2.0 | Github
  3. Swagger - API Development for Everyone

Gin & RESTful API

  1. 《基于 Go 语言构建企业级的 RESTful API 服务》| 掘金小册
  2. 教程：使用 go 的 gin 和 gorm 框架来构建 RESTful API 微服务 | LearnKu
  3. Build RESTful API service in golang using gin-gonic framework | Medium
  4. 对比 RESTful 与 SOAP，深入理解 RESTful | 紫川秀的博客
  5. RESTful API 设计规范 | 紫川秀的博客
  6. Gin - 高性能 Golang Web 框架的介绍和使用 | 代码成诗

swaggo 教程

  1. 如何使用 swagger 设计出漂亮的 RESTful API | 紫川秀的博客
  2. Go 学习笔记 (六) - 使用 swaggo 自动生成 Restful API 文档 | Razeen’s Blog
  3. Gin 实践 连载八：为它加上 Swagger - 煎鱼 | SegmentFault
  4. 3.8 为它加上 Swagger - 跟煎鱼学 Go | GitBook

doc.json 重定向至 about:blank

  1. doc.json link redirecting to blank page #194 - swaggo/swag | Github

validator 结构字段验证

  1. package validator | GoDoc
  2. 5.4 validator 请求校验 - Go 语言高级编程 | GitBook
  3. Golang 中的跨语言调用 - 习之北 | 须臾之学
  4. 结构字段验证 - validator.v9 | 博客园
  5. An easy way to validate Go request | Medium.com
  6. Gin 框架 - 数据绑定和验证 | 掘金
  7. Gin 框架构建 RESTFul API 之请求参数验证 | 忘归

binding 请求绑定

  1. BindJSON validation failed for a required integer field that has zero value - gin | Github
  2. bug:c.BindJSON(&req) - gin | Github
  3. Binding JSON having fields with empty string generates validation error - gin | Github
  4. Binding failed on int required field when value is 0 - gin | Github
  5. Bind validation bug with int zero value - gin | Github
  6. 模型绑定和验证 | Gin Web Framework
  7. Model binding and validation - gin-gonic/gin | Github

Gin 路由冲突

  1. Gin 的基数树路由局限及最佳实践 | 敬维
  2. 5.2 router 请求路由 - 《Go 语言高级编程》| GitBook

Shell 命令获取 IP 地址

  1. Shell 获取 IPv4 和 IPv6 地址的命令 | CSDN
  2. Shell 脚本中获取本机 IP 地址的三个方法 | ITeye
  3. Shell 命令行获取本机 IP，grep 的练习 | CSDN
  4. Linux 地址提示符和获取本机 IP Shell 命令 | CSDN