go-swagger

go-swagger 是一个 Golang 的第三方库，是一个 Swagger 2.0（aka OpenAPI 2.0）的 Golang 实现。

Github：https://github.com/go-swagger/go-swagger

go-swagger 内含了许多包，其中关键得有：

go-openapi：OpenAPI 的 Golang 实现。
govalidator：可以对 Golang 的字符串、结构体以及集合进行校验和检查的工具包。

go-swagger 还内含了许多 Swagger 工具库，安装 swagger 指令：

go get -u github.com/go-swagger/go-swagger/cmd/swagger

swagger 指令支持：

Serve specification UI，为 OpenAPI Specification 提供一个具有 UI 界面的服务器。
Validate a specification，验证 OpenAPI Specification 文件进行检查和校验。
Generate an API server，通过 OpenAPI Specification 生成服务端。
Generate an API client，通过 OpenAPI Specification 生成客户端。
Generate a spec from source，通过源码生成 OpenAPI Specification 文档。
Generate a data model，生成数据结构。
Transform specs，转换规范。
Compare specs，比较规范。

Generate a spec from source

swagger generate 指令会找到 main.go 文件，然后遍历所有源码文件，解析源码中与 Swagger 相关的注释，然后自动生成 swagger.json 文件，例如：

// Package classification User API.
//
// The purpose of this service is to provide an application
// that is using plain go code to define an API
//
//      Host: localhost
//      Version: 0.0.1
//
// swagger:meta
package service

然后在命令行里执行：

swagger generate spec -o ./swagger.json

当 swagger.json 就绪后，可以直接运行 swagger serve 指令启动 UI 程序：

swagger serve -F=swagger swagger.json

Generate an API server

有了 swagger.json 或 swagger.yaml 之后就可以生成 API server 了。

mkdir myapi
cd myapi
swagger generate server -f ~/myapi.yaml -A myapi
CGO_ENABLED=1 go build -o dist/myapi -a -gcflags "-N -l" ./cmd/myapi-server;
./dist/myapi

参考文档

https://juejin.im/post/6844903609390333965
https://blog.csdn.net/benben_2015/article/details/100538074

Go 语言编程 — go-swagger OpenAPI 工具相关推荐

Go 语言编程 — Cobra 指令行工具
目录文章目录目录 Cobra(眼镜蛇) Cobra 的核心概念 Cobra 的使用初始化应用程序的项目框架 main.go 生成应用程序的子命令(SubCmd) 实现 Command 的功能为 ...
Go 语言编程 — validator 数据校验工具
目录文章目录目录 Validator Quick start 约束类型特殊约束格式约束数据结构类型约束范围约束字符串约束唯一性约束跨字段约束自定义约束错误处理中文错误信息参考 ...
MDSF：面向语言编程LOP（Language Oriented Programming）方法介绍
好几年前看了JetBrains的CEO Sergey Dmitive一篇文章Language Oriented Programming - The Next Programming Paradigm才 ...
面向语言编程LOP（Language Oriented Programming）方法介绍
好几年前看了JetBrains的CEO Sergey Dmitive一篇文章Language Oriented Programming - The Next Programming Paradigm才 ...
linux c语言工具,Linux下C语言编程环境的工具.doc
Linux下C语言编程环境的工具 Linux下C语言编程环境的工具 Linux下C语言编程环境的工具要想在Linux下进行C语言编程,首先得搭建好一个编程环境.这里分别说明一下几个非常有用的软件包. ...
C 语言编程 — GCC 工具链
目录文章目录目录文章目录 GCC 工具链 GCC 编译器 GCC 的常用指令选项 GCC 所遵循的部分约定规则 Binutils C 运行时库 Clang 和 LLVM 文章目录 <C 语 ...
Perl/CGI脚本语言编程学习资料及开发工具下载大全
Practical Extraction and Report Language Perl 最初的设计者为拉里·沃尔(Larry Wall),它于1987年12月18日发表.Perl借取了C.sed. ...
易语言宝盒,易语言编程学习者必备工具
1.收集很多网上流行经典的易语言教程和一些常用的工具,易语言模块,易语言支持库.一键下载,双通道资源,保证资源不会失效. 2.支持在线观看,减少下载资源而浪费易友的时间! 3.支持一键下载宝盒上所有已 ...
好用的C语言编程软件！工具都没有，怎么用技术改变世界呢！
好用的C语言编程软件 1.VS(Visual Studio) VS是目前最流行的windows平台应用程序的集成开发环境,由于大部分同学使用的都是Windows操作系统,VS对于大家来说是极为合适的, ...
C/C++语言编程的隐患！
C/C++语言编程的隐患! 本文将带您了解一些良好的和内存相关的编码实践,以将内存错误保持在控制范围内.内存错误是 C 和 C++ 编程的祸根:它们很普遍,认识其严重性已有二十多年,但始终没有彻底解决 ...

Go 语言编程 — go-swagger OpenAPI 工具

目录

文章目录

go-swagger

Generate a spec from source

Generate an API server

参考文档

Go 语言编程 — go-swagger OpenAPI 工具相关推荐

最新文章

热门文章