Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add RegisterBodyEncoder #656

Merged
merged 1 commit into from Nov 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 28 additions & 2 deletions openapi3filter/req_resp_encoder.go
Expand Up @@ -16,8 +16,34 @@ func encodeBody(body interface{}, mediaType string) ([]byte, error) {
return encoder(body)
}

type bodyEncoder func(body interface{}) ([]byte, error)
type BodyEncoder func(body interface{}) ([]byte, error)

var bodyEncoders = map[string]bodyEncoder{
var bodyEncoders = map[string]BodyEncoder{
"application/json": json.Marshal,
}

func RegisterBodyEncoder(contentType string, encoder BodyEncoder) {
if contentType == "" {
panic("contentType is empty")
}
if encoder == nil {
panic("encoder is not defined")
}
bodyEncoders[contentType] = encoder
}

// This call is not thread-safe: body encoders should not be created/destroyed by multiple goroutines.
func UnregisterBodyEncoder(contentType string) {
if contentType == "" {
panic("contentType is empty")
}
delete(bodyEncoders, contentType)
}

// RegisteredBodyEncoder returns the registered body encoder for the given content type.
//
// If no encoder was registered for the given content type, nil is returned.
// This call is not thread-safe: body encoders should not be created/destroyed by multiple goroutines.
func RegisteredBodyEncoder(contentType string) BodyEncoder {
return bodyEncoders[contentType]
}
43 changes: 43 additions & 0 deletions openapi3filter/req_resp_encoder_test.go
@@ -0,0 +1,43 @@
package openapi3filter

import (
"fmt"
"net/http"
"strings"
"testing"

"github.com/stretchr/testify/require"
)

func TestRegisterAndUnregisterBodyEncoder(t *testing.T) {
var encoder BodyEncoder
encoder = func(body interface{}) (data []byte, err error) {
return []byte(strings.Join(body.([]string), ",")), nil
}
contentType := "text/csv"
h := make(http.Header)
h.Set(headerCT, contentType)

originalEncoder := RegisteredBodyEncoder(contentType)
require.Nil(t, originalEncoder)

RegisterBodyEncoder(contentType, encoder)
require.Equal(t, fmt.Sprintf("%v", encoder), fmt.Sprintf("%v", RegisteredBodyEncoder(contentType)))

body := []string{"foo", "bar"}
got, err := encodeBody(body, contentType)

require.NoError(t, err)
require.Equal(t, []byte("foo,bar"), got)

UnregisterBodyEncoder(contentType)

originalEncoder = RegisteredBodyEncoder(contentType)
require.Nil(t, originalEncoder)

_, err = encodeBody(body, contentType)
require.Equal(t, &ParseError{
Kind: KindUnsupportedFormat,
Reason: prefixUnsupportedCT + ` "text/csv"`,
}, err)
}