Skip to content

Commit

Permalink
support multipart/form-data (#502)
Browse files Browse the repository at this point in the history
  • Loading branch information
armersong committed Jul 3, 2022
1 parent 1e8c63c commit d9c71e1
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
8 changes: 8 additions & 0 deletions parameter.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ const (
// FormParameterKind = indicator of Request parameter type "form"
FormParameterKind

// MultiPartFormParameterKind = indicator of Request parameter type "multipart/form-data"
MultiPartFormParameterKind

// CollectionFormatCSV comma separated values `foo,bar`
CollectionFormatCSV = CollectionFormat("csv")

Expand Down Expand Up @@ -94,6 +97,11 @@ func (p *Parameter) beForm() *Parameter {
return p
}

func (p *Parameter) beMultiPartForm() *Parameter {
p.data.Kind = MultiPartFormParameterKind
return p
}

// Required sets the required field and returns the receiver
func (p *Parameter) Required(required bool) *Parameter {
p.data.Required = required
Expand Down
12 changes: 12 additions & 0 deletions web_service.go
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,18 @@ func FormParameter(name, description string) *Parameter {
return p
}

// MultiPartFormParameter creates a new Parameter of kind Form (using multipart/form-data) for documentation purposes.
// It is initialized as required with string as its DataType.
func (w *WebService) MultiPartFormParameter(name, description string) *Parameter {
return MultiPartFormParameter(name, description)
}

func MultiPartFormParameter(name, description string) *Parameter {
p := &Parameter{&ParameterData{Name: name, Description: description, Required: false, DataType: "string"}}
p.beMultiPartForm()
return p
}

// Route creates a new Route using the RouteBuilder and add to the ordered list of Routes.
func (w *WebService) Route(builder *RouteBuilder) *WebService {
w.routesLock.Lock()
Expand Down

0 comments on commit d9c71e1

Please sign in to comment.