blackteay/gf
1
0
Fork 0
mirror of https://github.com/gogf/gf.git synced 2025-04-05 03:05:05 +08:00
Code Issues Projects Releases Wiki Activity

fix(net/goai): change default value of RequestBody.Required from true to false, add required tag support for RequestBody (#3796)

Browse Source
This commit is contained in:
John Guo 2024-09-24 11:51:53 +08:00 committed by GitHub
parent e15b543a5b
commit 9af8393758
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 107 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
container/glist/glist_z_unit_test.go
View File

@ -291,7 +291,7 @@ func TestRemove(t *testing.T) {
})
}
func TestIssue4103(t *testing.T) {
func Test_Issue4103(t *testing.T) {
l1 := New()
l1.PushBack(1)
l1.PushBack(2)
@ -312,7 +312,7 @@ func TestIssue4103(t *testing.T) {
}
}
func TestIssue6349(t *testing.T) {
func Test_Issue6349(t *testing.T) {
l := New()
l.PushBack(1)
l.PushBack(2)

2
internal/deepcopy/deepcopy_test.go
View File

@ -908,7 +908,7 @@ func TestPointerToStruct(t *testing.T) {
}
}
func TestIssue9(t *testing.T) {
func Test_Issue9(t *testing.T) {
// simple pointer copy
x := 42
testA := map[string]*int{

1
net/ghttp/ghttp_server_config_api.go
View File

@ -17,6 +17,7 @@ func (s *Server) SetSwaggerUITemplate(swaggerUITemplate string) {
}
// SetOpenApiPath sets the OpenApiPath for server.
// For example: SetOpenApiPath("/api.json")
func (s *Server) SetOpenApiPath(path string) {
s.config.OpenApiPath = path
}

2
net/ghttp/ghttp_z_unit_issue_test.go
View File

@ -598,7 +598,7 @@ func (Issue3789) Say(ctx context.Context, req *Issue3789Req) (res *Issue3789Res,
}
// https://github.com/gogf/gf/issues/3789
func TestIssue3789(t *testing.T) {
func Test_Issue3789(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
s := g.Server()
s.Use(ghttp.MiddlewareHandlerResponse)

9
net/goai/goai_path.go
View File

@ -199,15 +199,16 @@ func (oai *OpenApiV3) addPath(in addPathInput) error {
if operation.RequestBody.Value == nil {
var (
requestBody = RequestBody{
Required: true,
Content: map[string]MediaType{},
Content: map[string]MediaType{},
}
)
// Supported mime types of request.
var (
contentTypes = oai.Config.ReadContentTypes
tagMimeValue = gmeta.Get(inputObject.Interface(), gtag.Mime).String()
contentTypes = oai.Config.ReadContentTypes
tagMimeValue = gmeta.Get(inputObject.Interface(), gtag.Mime).String()
tagRequiredValue = gmeta.Get(inputObject.Interface(), gtag.Required).Bool()
)
requestBody.Required = tagRequiredValue
if tagMimeValue != "" {
contentTypes = gstr.SplitAndTrim(tagMimeValue, ",")
}

72
net/goai/goai_z_unit_issue_test.go Normal file
View File

@ -0,0 +1,72 @@
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package goai_test
import (
"context"
"fmt"
"testing"
"time"
"github.com/gogf/gf/v2/encoding/gjson"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/net/ghttp"
"github.com/gogf/gf/v2/test/gtest"
)
var ctx = context.Background()
type Issue3664DefaultReq struct {
g.Meta `path:"/default" method:"post"`
Name string
}
type Issue3664DefaultRes struct{}
type Issue3664RequiredTagReq struct {
g.Meta `path:"/required-tag" required:"true" method:"post"`
Name string
}
type Issue3664RequiredTagRes struct{}
type Issue3664 struct{}
func (Issue3664) Default(ctx context.Context, req *Issue3664DefaultReq) (res *Issue3664DefaultRes, err error) {
res = &Issue3664DefaultRes{}
return
}
func (Issue3664) RequiredTag(ctx context.Context, req *Issue3664RequiredTagReq) (res *Issue3664RequiredTagRes, err error) {
res = &Issue3664RequiredTagRes{}
return
}
// https://github.com/gogf/gf/issues/3664
func Test_Issue3664(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
s := g.Server()
s.Use(ghttp.MiddlewareHandlerResponse)
s.Group("/", func(group *ghttp.RouterGroup) {
group.Bind(
new(Issue3664),
)
})
s.SetLogger(nil)
s.SetOpenApiPath("/api.json")
s.SetDumpRouterMap(false)
s.Start()
defer s.Shutdown()
time.Sleep(100 * time.Millisecond)
c := g.Client()
c.SetPrefix(fmt.Sprintf("http://127.0.0.1:%d", s.GetListenedPort()))
apiContent := c.GetContent(ctx, "/api.json")
j, err := gjson.LoadJson(apiContent)
t.AssertNil(err)
t.Assert(j.Get(`paths./default.post.requestBody.required`).String(), "")
t.Assert(j.Get(`paths./required-tag.post.requestBody.required`).String(), "true")
})
}

8
os/glog/glog_logger.go
View File

@ -355,11 +355,19 @@ func (l *Logger) getFpFromPool(ctx context.Context, path string) *gfpool.File {
// printStd prints content `s` without stack.
func (l *Logger) printStd(ctx context.Context, level int, values ...interface{}) {
// nil logger, print nothing
if l == nil {
return
}
l.print(ctx, level, "", values...)
}
// printErr prints content `s` with stack check.
func (l *Logger) printErr(ctx context.Context, level int, values ...interface{}) {
// nil logger, print nothing
if l == nil {
return
}
var stack string
if l.config.StStatus == 1 {
stack = l.GetStack()

4
os/glog/glog_logger_api.go
View File

@ -142,5 +142,9 @@ func (l *Logger) Criticalf(ctx context.Context, format string, v ...interface{})
// checkLevel checks whether the given `level` could be output.
func (l *Logger) checkLevel(level int) bool {
// nil logger, print nothing
if l == nil {
return false
}
return l.config.Level&level > 0
}

24
util/gconv/gconv_z_unit_issue_test.go
View File

@ -22,7 +22,7 @@ import (
)
// https://github.com/gogf/gf/issues/1227
func TestIssue1227(t *testing.T) {
func Test_Issue1227(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type StructFromIssue1227 struct {
Name string `json:"n1"`
@ -130,7 +130,7 @@ func (f *issue1607Float64) UnmarshalValue(value interface{}) error {
return nil
}
func TestIssue1607(t *testing.T) {
func Test_Issue1607(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type Demo struct {
B issue1607Float64
@ -148,7 +148,7 @@ func TestIssue1607(t *testing.T) {
}
// https://github.com/gogf/gf/issues/1946
func TestIssue1946(t *testing.T) {
func Test_Issue1946(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type B struct {
init *gtype.Bool
@ -222,7 +222,7 @@ func TestIssue1946(t *testing.T) {
}
// https://github.com/gogf/gf/issues/2381
func TestIssue2381(t *testing.T) {
func Test_Issue2381(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type Inherit struct {
Id int64 `json:"id" description:"Id"`
@ -259,7 +259,7 @@ func TestIssue2381(t *testing.T) {
}
// https://github.com/gogf/gf/issues/2391
func TestIssue2391(t *testing.T) {
func Test_Issue2391(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type Inherit struct {
Ids []int
@ -299,7 +299,7 @@ func TestIssue2391(t *testing.T) {
}
// https://github.com/gogf/gf/issues/2395
func TestIssue2395(t *testing.T) {
func Test_Issue2395(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
type Test struct {
Num int
@ -311,7 +311,7 @@ func TestIssue2395(t *testing.T) {
}
// https://github.com/gogf/gf/issues/2371
func TestIssue2371(t *testing.T) {
func Test_Issue2371(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
var (
s = struct {
@ -327,7 +327,7 @@ func TestIssue2371(t *testing.T) {
}
// https://github.com/gogf/gf/issues/2901
func TestIssue2901(t *testing.T) {
func Test_Issue2901(t *testing.T) {
type GameApp2 struct {
ForceUpdateTime *time.Time
}
@ -342,7 +342,7 @@ func TestIssue2901(t *testing.T) {
}
// https://github.com/gogf/gf/issues/3006
func TestIssue3006(t *testing.T) {
func Test_Issue3006(t *testing.T) {
type tFF struct {
Val1 json.RawMessage `json:"val1"`
Val2 []json.RawMessage `json:"val2"`
@ -369,7 +369,7 @@ func TestIssue3006(t *testing.T) {
}
// https://github.com/gogf/gf/issues/3731
func TestIssue3731(t *testing.T) {
func Test_Issue3731(t *testing.T) {
type Data struct {
Doc map[string]interface{} `json:"doc"`
}
@ -389,7 +389,7 @@ func TestIssue3731(t *testing.T) {
}
// https://github.com/gogf/gf/issues/3764
func TestIssue3764(t *testing.T) {
func Test_Issue3764(t *testing.T) {
type T struct {
True bool `json:"true"`
False bool `json:"false"`
@ -416,7 +416,7 @@ func TestIssue3764(t *testing.T) {
}
// https://github.com/gogf/gf/issues/3789
func TestIssue3789(t *testing.T) {
func Test_Issue3789(t *testing.T) {
type ItemSecondThird struct {
SecondID uint64 `json:"secondId,string"`
ThirdID uint64 `json:"thirdId,string"`

1
util/gtag/gtag.go
View File

@ -46,6 +46,7 @@ const (
Json = "json" // Json tag is supported by stdlib.
Security = "security" // Security defines scheme for authentication. Detail to see https://swagger.io/docs/specification/authentication/
In = "in" // Swagger distinguishes between the following parameter types based on the parameter location. Detail to see https://swagger.io/docs/specification/describing-parameters/
Required = "required" // OpenAPIv3 required attribute name for request body.
)
// StructTagPriority defines the default priority tags for Map*/Struct* functions.