# gin-openapi3-knife4go

**Repository Path**: delegy/gin-openapi3-knife4go

## Basic Information

- **Project Name**: gin-openapi3-knife4go
- **Description**: 在gin-swagger的基础上，让knif4j适配go，作为对gin-swagger接口文档界面的升级。
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-26
- **Last Updated**: 2025-05-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# gin-swagger-knife4go

#### 介绍
优化gin-swagger的界面,让knif4j适配go语言

【鸣谢】：https://gitee.com/youbeiwuhuan/knife4go
在上面这位的基础上，增加了relativePath，以便在knife4j（knife4go）的接口文档页面中进行【接口调试】。
默认接口文档中项目前缀路径（relativePath/contextPath）为 "/knife"，现可定制此项。

###如何使用

1. 首先go项目需要在gin-swagger的基础上,在swagger.json生成后，将其以knife进行初始化。

```go
// _ 使用openApi3的接口文档
bytes, err := os.ReadFile("【你的swagger.json在项目中的相对路径。如：`docs/swagger.json`】")
if err != nil {
	panic(err)
}
swaggerJson := string(bytes)

// 定制【项目contextPath】
gin_openapi3_knife.InitRelativePath("/v1")
// 初始化
gin_openapi3_knife4go.InitSwaggerKnife(router, swaggerJson)
```

2. 将该接口文档能够以knife4的UI访问（通过 [contextPath]/doc.html访问）。（不影响原始swagger的 `/v1/swagger/index.html` 的访问）