loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

[Go][Server] FormParams - Generic Array Type Handling (#17001)

Browse Source 
* If a form param is an array and isn't caught in the previous checks, treat it as a slice of strings.

* Add an example of a FormParam that is an array
This commit is contained in:
Ian Cubbon 2023-11-07 23:09:12 -07:00 committed by GitHub
parent e9507077fc
commit 291ce353ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 32 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
modules/openapi-generator/src/main/resources/go-server/controller-api.mustache vendored
View File

@ -495,7 +495,12 @@ func (c *{{classname}}Controller) {{nickname}}(w http.ResponseWriter, r *http.Re
{{/isArray}}{{/isInteger}} {{/isArray}}{{/isInteger}}
{{^isFile}} {{^isFile}}
{{^isLong}} {{^isLong}}
{{#isArray}}
{{paramName}}Param := strings.Split(r.FormValue("{{baseName}}"), ",")
{{/isArray}}
{{^isArray}}
{{paramName}}Param := r.FormValue("{{baseName}}") {{paramName}}Param := r.FormValue("{{baseName}}")
{{/isArray}}
{{/isLong}} {{/isLong}}
{{/isFile}} {{/isFile}}
{{/isFormParam}} {{/isFormParam}}

5
modules/openapi-generator/src/test/resources/3_0/go-server/petstore.yaml
View File

@ -346,6 +346,11 @@ paths:
additionalMetadata: additionalMetadata:
description: Additional data to pass to server description: Additional data to pass to server
type: string type: string
extraOptionalMetadata:
description: More data to pass to server
type: array
items:
type: string
file: file:
description: file to upload description: file to upload
type: string type: string

5
samples/server/petstore/go-api-server/api/openapi.yaml
View File

@ -1194,6 +1194,11 @@ components:
additionalMetadata: additionalMetadata:
description: Additional data to pass to server description: Additional data to pass to server
type: string type: string
extraOptionalMetadata:
description: More data to pass to server
items:
type: string
type: array
file: file:
description: file to upload description: file to upload
format: binary format: binary

2
samples/server/petstore/go-api-server/go/api.go
View File

@ -76,7 +76,7 @@ type PetAPIServicer interface {
GetPetsUsingBooleanQueryParameters(context.Context, bool, bool, bool) (ImplResponse, error) GetPetsUsingBooleanQueryParameters(context.Context, bool, bool, bool) (ImplResponse, error)
UpdatePet(context.Context, Pet) (ImplResponse, error) UpdatePet(context.Context, Pet) (ImplResponse, error)
UpdatePetWithForm(context.Context, int64, string, string) (ImplResponse, error) UpdatePetWithForm(context.Context, int64, string, string) (ImplResponse, error)
UploadFile(context.Context, int64, string, *os.File) (ImplResponse, error) UploadFile(context.Context, int64, string, []string, *os.File) (ImplResponse, error)
UploadFileArrayOfFiles(context.Context, int64, string, []*os.File) (ImplResponse, error) UploadFileArrayOfFiles(context.Context, int64, string, []*os.File) (ImplResponse, error)
} }

5
samples/server/petstore/go-api-server/go/api_pet.go
View File

@ -407,6 +407,9 @@ func (c *PetAPIController) UploadFile(w http.ResponseWriter, r *http.Request) {
additionalMetadataParam := r.FormValue("additionalMetadata") additionalMetadataParam := r.FormValue("additionalMetadata")
extraOptionalMetadataParam := strings.Split(r.FormValue("extraOptionalMetadata"), ",")
fileParam, err := ReadFormFileToTempFile(r, "file") fileParam, err := ReadFormFileToTempFile(r, "file")
if err != nil { if err != nil {
c.errorHandler(w, r, &ParsingError{Err: err}, nil) c.errorHandler(w, r, &ParsingError{Err: err}, nil)
@ -414,7 +417,7 @@ func (c *PetAPIController) UploadFile(w http.ResponseWriter, r *http.Request) {
} }
result, err := c.service.UploadFile(r.Context(), petIdParam, additionalMetadataParam, fileParam) result, err := c.service.UploadFile(r.Context(), petIdParam, additionalMetadataParam, extraOptionalMetadataParam, fileParam)
// If an error occurred, encode the error with the status code // If an error occurred, encode the error with the status code
if err != nil { if err != nil {
c.errorHandler(w, r, err, &result) c.errorHandler(w, r, err, &result)

2
samples/server/petstore/go-api-server/go/api_pet_service.go
View File

@ -173,7 +173,7 @@ func (s *PetAPIService) UpdatePetWithForm(ctx context.Context, petId int64, name
} }
// UploadFile - uploads an image // UploadFile - uploads an image
func (s *PetAPIService) UploadFile(ctx context.Context, petId int64, additionalMetadata string, file *os.File) (ImplResponse, error) { func (s *PetAPIService) UploadFile(ctx context.Context, petId int64, additionalMetadata string, extraOptionalMetadata []string, file *os.File) (ImplResponse, error) {
// TODO - update UploadFile with the required logic for this service method. // TODO - update UploadFile with the required logic for this service method.
// Add api_pet_service.go to the .openapi-generator-ignore to avoid overwriting this service implementation when updating open api generation. // Add api_pet_service.go to the .openapi-generator-ignore to avoid overwriting this service implementation when updating open api generation.

5
samples/server/petstore/go-chi-server/api/openapi.yaml
View File

@ -1194,6 +1194,11 @@ components:
additionalMetadata: additionalMetadata:
description: Additional data to pass to server description: Additional data to pass to server
type: string type: string
extraOptionalMetadata:
description: More data to pass to server
items:
type: string
type: array
file: file:
description: file to upload description: file to upload
format: binary format: binary

2
samples/server/petstore/go-chi-server/go/api.go
View File

@ -76,7 +76,7 @@ type PetAPIServicer interface {
GetPetsUsingBooleanQueryParameters(context.Context, bool, bool, bool) (ImplResponse, error) GetPetsUsingBooleanQueryParameters(context.Context, bool, bool, bool) (ImplResponse, error)
UpdatePet(context.Context, Pet) (ImplResponse, error) UpdatePet(context.Context, Pet) (ImplResponse, error)
UpdatePetWithForm(context.Context, int64, string, string) (ImplResponse, error) UpdatePetWithForm(context.Context, int64, string, string) (ImplResponse, error)
UploadFile(context.Context, int64, string, *os.File) (ImplResponse, error) UploadFile(context.Context, int64, string, []string, *os.File) (ImplResponse, error)
UploadFileArrayOfFiles(context.Context, int64, string, []*os.File) (ImplResponse, error) UploadFileArrayOfFiles(context.Context, int64, string, []*os.File) (ImplResponse, error)
} }

5
samples/server/petstore/go-chi-server/go/api_pet.go
View File

@ -401,6 +401,9 @@ func (c *PetAPIController) UploadFile(w http.ResponseWriter, r *http.Request) {
additionalMetadataParam := r.FormValue("additionalMetadata") additionalMetadataParam := r.FormValue("additionalMetadata")
extraOptionalMetadataParam := strings.Split(r.FormValue("extraOptionalMetadata"), ",")
fileParam, err := ReadFormFileToTempFile(r, "file") fileParam, err := ReadFormFileToTempFile(r, "file")
if err != nil { if err != nil {
c.errorHandler(w, r, &ParsingError{Err: err}, nil) c.errorHandler(w, r, &ParsingError{Err: err}, nil)
@ -408,7 +411,7 @@ func (c *PetAPIController) UploadFile(w http.ResponseWriter, r *http.Request) {
} }
result, err := c.service.UploadFile(r.Context(), petIdParam, additionalMetadataParam, fileParam) result, err := c.service.UploadFile(r.Context(), petIdParam, additionalMetadataParam, extraOptionalMetadataParam, fileParam)
// If an error occurred, encode the error with the status code // If an error occurred, encode the error with the status code
if err != nil { if err != nil {
c.errorHandler(w, r, err, &result) c.errorHandler(w, r, err, &result)

2
samples/server/petstore/go-chi-server/go/api_pet_service.go
View File

@ -173,7 +173,7 @@ func (s *PetAPIService) UpdatePetWithForm(ctx context.Context, petId int64, name
} }
// UploadFile - uploads an image // UploadFile - uploads an image
func (s *PetAPIService) UploadFile(ctx context.Context, petId int64, additionalMetadata string, file *os.File) (ImplResponse, error) { func (s *PetAPIService) UploadFile(ctx context.Context, petId int64, additionalMetadata string, extraOptionalMetadata []string, file *os.File) (ImplResponse, error) {
// TODO - update UploadFile with the required logic for this service method. // TODO - update UploadFile with the required logic for this service method.
// Add api_pet_service.go to the .openapi-generator-ignore to avoid overwriting this service implementation when updating open api generation. // Add api_pet_service.go to the .openapi-generator-ignore to avoid overwriting this service implementation when updating open api generation.