Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nullswan/gin-api-replay-usage
Gin middleware that export important data from passed request and process them in a passed function.
https://github.com/nullswan/gin-api-replay-usage
gin gin-api gin-middleware go golang
Last synced: about 1 month ago
JSON representation
Gin middleware that export important data from passed request and process them in a passed function.
- Host: GitHub
- URL: https://github.com/nullswan/gin-api-replay-usage
- Owner: nullswan
- Created: 2021-04-16T20:57:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-05-04T14:27:33.000Z (over 3 years ago)
- Last Synced: 2024-09-30T07:21:33.526Z (about 2 months ago)
- Topics: gin, gin-api, gin-middleware, go, golang
- Language: Go
- Homepage:
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gin-api-replay-usage
See examples for passing func to tearDown, can be used to save document in (any) database or direct parsing through rpcx.
Errors Assertion:\
Error field is automatically set when response is different from 301 (Redirection) and 200 (Success)
Error_msg is set when you return error in your body.
```
type ResponseError struct {
Code int `json:"code"`
Message string `json:"message"`
}
{
"code": 404,
"error": "not found"
}
```
## Example returned typed Struct
```
type ReplayData struct {
Time int64
Host, Path, Method, URL string
Status_code int
Error bool
Error_msg string
Client struct {
Referer, Authorization, Origin, Remote_address, User_agent, Platform, Browser string
}
Request struct {
Process_time, Content_length int64
Mimetype, Body string
Headers map[string]string
Args map[string][]string
}
Response struct {
Content_length int
Mimetype, Body string
Headers map[string][]string
}
}
```
## Example Output Document
```
{
"Time": 1618606390449228744,
"Host": "localhost:3000",
"Path": "/stars",
"Method": "GET",
"URL": "localhost:3000",
"Status_code": 200,
"Error": false,
"Error_msg": "some error msg if any",
"Client": {
"Referer": "some ref if any",
"Authorization": "Bearer Authorization",
"Origin": "some origin if any",
"Remote_address": "::1",
"User_agent": "Mozilla/5.0 ... (Truncated Manually)",
"Platform": "",
"Browser": ""
},
"Request": {
"Process_time": 9496,
"Content_length": 38,
"Mimetype": "application/json",
"Body": "{"username": "usr", "password": "pwd"}",
"Headers": {
"Upgrade-Insecure-Requests" : "1",
"Cache-Control" : "max-age=0",
"Accept" : "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8",
"Accept-Language" : "en-US,en;q=0.5",
"Accept-Encoding" : "gzip, deflate",
"Connection" : "keep-alive"
"User-Agent": "Mozilla/5.0 ... (Truncated Manually)",
},
"Args": {
"a": [
"87"
]
}
},
"Response": {
"Content_length": 6,
"Mimetype": "application/json; charset=utf-8",
"Body": "\"pong"",
"Headers": {
"Content-Type": [
"application/json; charset=utf-8"
]
}
}
}
```