Git Product home page Git Product logo

gin-swagger-demo's Introduction

gin-swagger-demo

简体中文 | English

使用gin-swagger在一个项目中生成多个Swagger文档

go 版本 >= 1.16

需求和效果

gin项目有多个版本,例如v1 v2,或者有子项目时,如果只生成一个文档,会导致文档混乱不好阅读。所以我们为每个版本或子项目单独生成一个文档,并且通过不同路由来访问。

img.png img_1.png

如何使用demo

下载demo

git clone https://github.com/lhl1115/gin-swagger-demo.git
cd gin-swagger-demo
go mod tidy
go run cmd/v1/main.go
or
go run cmd/control/main.go
or
go run --tags "doc" ./cmd/v2

访问浏览器查看Swagger文档

http://localhost:8081/swagger/v1/index.html
http://localhost:8081/swagger/v2/index.html
http://localhost:8081/swagger/control/index.html

生成Swagger文档

// 生成全部文档
swag init -g  cmd/v1/main.go  -o ./docs/swag  --instanceName v1

// 生成v2文档
swag init -g  ../../cmd/v2/main.go  -d internal/v2  -o ./docs/swag  --parseDependency --instanceName v2

// 生成control文档
swag init -g  ../../cmd/control/main.go  -d internal/control  -o ./docs/swag  --parseDependency --instanceName control

打包时忽略swag文档

在v2版本中我们给swag.go加上了 +build doc ,这样就可以在打包时按需忽略swag文档,减少打包后体积。

// 打包后体积约11M 无swag文档
go build -o v2.exe ./cmd/v2

// 打包后体积约26M 有swag文档
go build -o v2_doc.exe -tags "doc" ./cmd/v2

我也同步编写了一篇博客,如果您需要更详细的介绍,可以查看:gin-swagger-blog

gin-swagger-demo's People

Contributors

lhl1115 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.