shuqingzai
commented
2 months ago GF 目前处理响应只有一个结果 200
See: https://github.com/gogf/gf/blob/6e5ce98d23c65fd7283c84382abfde62a29f9930/net/goai/goai_path.go#L239
无法自定义状态码，在一些 2xx 状态中代表不同含义，参考: 201 Created
需要根据这些状态码响应
- 创建成功，希望可以设置为
201 - 异步任务，延迟处理的，希望为
202
目前 GF 没有支持这个，有一个想法参考:
在 xxxRes.Meta 中设置 successStatusCode 或 errorStatusCode 标签，框架可以解析且设置对应的 HTTP Status Code 文档
server:
address: ":8199"
openapiPath: "/api.json"
swaggerPath: "/swagger"package main
import (
"context"
"net/http"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/net/ghttp"
"github.com/gogf/gf/v2/net/goai"
)
type HelloCreateReq struct {
g.Meta `path:"/hello" method:"POST"`
Name string `v:"required" dc:"Your name"`
Age int `v:"required|between:1,200" dc:"Your age"`
}
type HelloCreateRes struct {
g.Meta `successStatusCode:"201" errorStatusCode:"400,500"`
ID uint64 `json:"id,string" dc:"ID"`
}
type HelloGetReq struct {
g.Meta `path:"/hello/{id}" method:"GET"`
// ID ID
ID uint64 `json:"id,string" dc:"ID" in:"path" v:"required"`
}
type HelloGetRes struct {
g.Meta `errorStatusCode:"400,500"`
ID uint64 `json:"id,string" dc:"ID"`
Name string `json:"name" dc:"Name"`
Age int `json:"age" dc:"Age"`
}
type Hello struct{}
func (c *Hello) Create(ctx context.Context, r *HelloCreateReq) (*HelloCreateRes, error) {
return &HelloCreateRes{ID: 1}, nil
}
func (c *Hello) Get(ctx context.Context, r *HelloGetReq) (*HelloGetRes, error) {
return &HelloGetRes{
ID: r.ID,
Name: "john",
Age: 18,
}, nil
}
func main() {
s := g.Server()
s.Use(ghttp.MiddlewareHandlerResponse)
s.Group("/", func(group *ghttp.RouterGroup) {
group.Bind(
new(Hello),
)
})
// 设置响应数据结构
oai := s.GetOpenApi()
oai.Config.CommonResponse = ghttp.DefaultHandlerResponse{}
oai.Config.CommonResponseDataField = "Data"
// 错误的响应
dataResp := &goai.Schemas{}
dataResp.Set("code", goai.SchemaRef{
Value: &goai.Schema{
Type: "integer",
Format: "int32",
Title: "业务状态码",
Description: "业务状态码",
},
})
dataResp.Set("message", goai.SchemaRef{
Value: &goai.Schema{
Type: "string",
Title: "业务状态描述",
Description: "业务状态描述",
},
})
dataResp.Set("data", goai.SchemaRef{
Value: &goai.Schema{
Type: "object",
Title: "业务数据",
Description: "业务数据",
Nullable: true,
},
})
oai.Components.Schemas.Set("bizmodel.HTTPResponse", goai.SchemaRef{
Value: &goai.Schema{
Type: "object",
Properties: dataResp,
},
})
// 错误的响应状态码匹配
oai.Components.Responses = goai.Responses{
// 也许我们需要将 key 的空格去掉？？？
http.StatusText(http.StatusBadRequest): goai.ResponseRef{
Value: &goai.Response{
Description: "BadRequest",
Content: map[string]goai.MediaType{
"application/json": {Schema: &goai.SchemaRef{Ref: "bizmodel.HTTPResponse"}},
},
},
},
http.StatusText(http.StatusNotFound): goai.ResponseRef{
Value: &goai.Response{
Description: "NotFound",
Content: map[string]goai.MediaType{
"application/json": {Schema: &goai.SchemaRef{Ref: "bizmodel.HTTPResponse"}},
},
},
},
http.StatusText(http.StatusInternalServerError): goai.ResponseRef{
Value: &goai.Response{
Description: "InternalServerError",
Content: map[string]goai.MediaType{
"application/json": {Schema: &goai.SchemaRef{Ref: "bizmodel.HTTPResponse"}},
},
},
},
}
s.Run()
}HelloCreateRes中设置successStatusCode为201，那么应该生成201文档，也设置了400和500且这两个response的文档可以在文档的components.responses中通过HTTP Status text匹配到，也应该设置到文档中HelloGetRes中没有设置successStatusCode则应该默认生成200的文档
Issues-translate-bot
ivothgle
gqcn
github-actions[bot]
UncleChair
Go version
go1.22
GoFrame version
2.7.0
Can this bug be reproduced with the latest release?
Option Yes
What did you do?
I want to customize the response 500 content，
output "500": { "$ref": "#/components/schemas/InternalServerError" } He should be "#/components/responses/InternalServerError"， see https://swagger.io/docs/specification/describing-responses/
What did you see happen?
It is not possible to customize the reference response structure in OpenAI because its prefix is always fixed
code is: https://github.com/gogf/gf/blob/6e5ce98d23c65fd7283c84382abfde62a29f9930/net/goai/goai.go#L227
What did you expect to see?
He should be "#/components/responses/InternalServerError"， see https://swagger.io/docs/specification/describing-responses/