README.md · 啾啾/knife4go

# knife4go

#### 项目调整中... （今年加班太多，维护缓慢，大家谅解）
- 1. 将openapi3.0和swagger2.0的支持单独列分支,master将保持swagger2.0支持。解决现存的。
- 2. 解决现存openapi3.0支持bug。
- 3. 拉新分支用https://github.com/wI2L/fizz 来适配knife4j的ui,不用再生成swagger.json。

#### 介绍
优化gin-swagger的界面,让knif4j适配go语言。感谢萧明。
knif4j地址：https://gitee.com/xiaoym/knife4j

#### 效果图
![image](https://gitee.com/youbeiwuhuan/knife4go/raw/master/img/knife4go.png)

#### 模块说明
| 模块                        | 描述                                                                    |  
|---------------------------|:----------------------------------------------------------------------| 
| gin-swagger-knife         | 替换gin-swagger的界面实现(并非在原项目代码上修改)，供gin项目引用 (适用于swagger2)                |  
| gin-openapi3-knife        | 替换gin-swagger的界面实现(并非在原项目代码上修改)，供gin项目引用 (适用于openapi3)                |  
| fizz-knife                | 替换fizz的界面实现(并非在原项目代码上修改)，供gin项目引用 (基于fizz展示openapi3,不需要用swagger.json) |  
| knife-vue-dist            | knife4j-vue项目打包后的dist目录内容，用于knife-vue-2-go-code中生成代码的逻辑               |    
| knife-vue-2-go-code       | 用于生成gin-swagger-knife中的代码，方便根据最新版本的knif4j升级界面                         |      
| knife4go-example          | gin-swagger-knife 使用示例（废弃）                                            |
| gin-swagger-knife-example | gin-swagger-knife 使用示例                                                |
| gin-swagger-knife-example | gin-swagger-knife 使用示例                                                |
| fizz-knife-example        | fizz-knife 使用示例                                                       |

#### 使用步骤
- 1. 按照传统gin-swagger方式生成swagger.json,将内容拷贝到一个字符串中。关于gin-swagger的使用参考[gin-swagger生成API文档](https://www.cnblogs.com/zhzhlong/p/11800787.html) 或  [swaggo项目](https://github.com/swaggo/swag)
	- 1.1 先下载cmd包，才能执行相关命令
		go get -u github.com/swaggo/swag/cmd/swag
		我开始没成功，后来进入$GOPATH/bin/ 目录执行go get github.com/swaggo/swag/cmd/swag ，在bin目录下生成一个swag.exe文件，把$GOPATH/bin/ 添加到Path环境变量才算成功
	- 1.2 执行初始化命令（相关的swagger注释写法参照gin-swagger官网）
		swag init  // 注意，一定要和main.go处于同一级目录
		初始化命令，在根目录生成一个docs文件夹，swagger.json就在该文件夹中
			docs/swagger.json
	- 1.3 将swagger.json的内容拷贝到下面示例代码的swaggerJson变量中
	
	
	
- 2. 引入gin-swagger-knife项目
	go get gitee.com/youbeiwuhuan/knife4go/gin-swagger-knife
	
	
- 3.  gin 中初始化相关访问路径
	![image](https://gitee.com/youbeiwuhuan/knife4go/raw/master/img/example.png)

``` go
		
		import (
			"fmt"
			gin_swagger_knife "gitee.com/youbeiwuhuan/knife4go/gin-swagger-knife"
			"github.com/gin-gonic/gin"
		)
		
		router := gin.Default()
		// 获取 swag int 命令生成的swagger.json文件里的内容
		swaggerJson := "swagger.json的内容"
		//初始化gin路径
		gin_swagger_knife.InitSwaggerKnife(router,swaggerJson)
		router.Run(":8080")
	```

- 4. 访问
	http://127.0.0.1:8080/knife/doc.html

啾啾/knife4go

简介

发行版

贡献者

近期动态

啾啾/knife4go .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

啾啾/knife4go