hypnoglow/oas2

OpenAPI 2.0 (aka Swagger) utils for Golang.

oas2's Issues

collectionFormat property is missing

Looks like collectionFormat is missing from parsing parameters process. Docs are here.

Here is a code to reproduce a bug I've faced

Swagger spec

swagger: "2.0"
info:
  version: debug
  title: Title
basePath: /api
schemes: [http]
produces: [text/plain]

paths:
  /test:
    get:
      description: Description
      operationId: test
      parameters:
        - name: param
          in: query
          type: array
          collectionFormat: csv
          items:
            type: string
      responses:
        "200":
          description: Response
          schema:
            type: string

Code

package main

import (
	"fmt"
	"net/http"
	"github.com/hypnoglow/oas2"
)

func main() {
	spec, err := oas.LoadFile("./swagger.yaml")
	if err != nil {
		panic(err)
	}
	r, err := oas.NewRouter(
		spec,
		oas.OperationHandlers{"test": http.HandlerFunc(handle)},
	)

	fmt.Println("Listening on :8080...")
	if err := http.ListenAndServe(":8080", r); err != nil {
		panic(err)
	}
}

func handle(w http.ResponseWriter, req *http.Request) {
	var q query
	if err := oas.DecodeQuery(req, &q); err != nil {
		panic(err)
	}

	// Return results of parsing to client
	resp := ""
	for i, v := range q.Param {
		resp += fmt.Sprintf("%d:%s;", i, v)
	}
	w.Write([]byte(resp + "\n"))
}

type query struct {
	Param []string `oas:"param"`
}

Run and check

$ curl 'http://localhost:8080/api/test?param=x,y'
0:x,y;

As you can see param string is not split into []string{"x", "y"} array, but instead stayed []string{"x,y"}.

I'll provide pr shortly.

Forms support

The package should support validating form params and provide a function to decode data from form params to the supplied struct. Same thing as query parameters.

It should support both application/x-www-form-urlencoded and multipart/form-data.

Ref: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterObject

Enable custom validators

Currently, custom validators like partial time are not enabled.

The specification allows to have custom formats and to validate against them.

We should enable custom validator support as pluggable extensions, so functions like validate.Query can be instructed to validate certain custom formats.