# go-apidoc

**Repository Path**: lshsuper/go-apidoc

## Basic Information

- **Project Name**: go-apidoc
- **Description**: go api 文档定义
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-07
- **Last Updated**: 2025-09-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### go-apidoc

#### 概括

通过注册请求参数，动态生成标准api接口文档，目前在完善中。


#### 如何使用

##### 三步结合你的接口请求，将文档注册完成，无需额外维护脚本，只维护自身接口必用的请求参数定义即可

Step 1:实例化doc

```
d := doc.NewDoc(doc.DocCfg{
		DocInfo: doc.DocInfo{
			Title:       "用户中心 api",
			Version:     "1.0.0",
			Description: "订单api",
			Scheme: []string{
				"http",
				"https",
			},
			Host:        "gitee.com",
			RenderStyle: doc.RenderStylePretty,
		},
	})
```

Step 2:注册相关模型

```
d.RegisterRequest(GetUserRequest{}, GetTagRequest{}, AddUserRequest{})
d.RegisterDefine(AUserWork{}, CompanyInfo{}, DeptInfo{})
d.GenDoc()
```

Step 3:注册路由（以gin为例，支持多类型框架注册）

```
r.Handle(http.MethodGet, "/doc", func(c *gin.Context) {
		d.Handler(c.Writer, c.Request)
})
```