OpenAPI - Assert
Description
openapi-assert is a Go package that provides a affordable way to validate http requests and responses data throught OpenAPI Schema Specification (Swagger) and the project was inspired by PHP Swagger Assertions. It has the following features:
- Assert request and response media types
- Assert request and response headers
- Assert request query strings
- Assert request and response body.
- Assert the entire http request and response object.
Requirements
OpenAPI Assert requires Go 1.11 or later.
Instalation
Use go get.
$ go get github.com/faabiosr/openapi-assertThen import the package into your own code:
import "github.com/faabiosr/openapi-assert"
Usage
The package provides methods that allow you to assert raw data using swagger files.
See it in action:
package main
import (
assert "github.com/faabiosr/openapi-assert"
"log"
"net/http"
)
func main() {
doc, err := assert.LoadFromURI("http://petstore.swagger.io/v2/swagger.json")
if err != nil {
log.Fatal(err)
}
assert := assert.New(doc)
log.Println(
assert.RequestMediaType("text/html", "/pet", http.MethodPost),
)
log.Println(
assert.RequestMediaType("image/gif", "/v2/pet", http.MethodPost),
)
}Asserting http request object using the swagger schema file:
package main
import (
"fmt"
assert "github.com/faabiosr/openapi-assert"
"log"
"net/http"
)
func main() {
doc, err := assert.LoadFromURI("http://petstore.swagger.io/v2/swagger.json")
if err != nil {
log.Fatal(err)
}
assert := assert.New(doc)
http.HandleFunc("/v2/pet", func(w http.ResponseWriter, r *http.Request) {
err := assert.Request(r)
fmt.Fprint(w, err)
})
log.Fatal(
http.ListenAndServe("127.0.0.1:9000", nil),
)
}Asserting http response object using the swagger schema file:
package main
import (
assert "github.com/faabiosr/openapi-assert"
"log"
"net/http"
)
func main() {
doc, err := assert.LoadFromURI("http://petstore.swagger.io/v2/swagger.json")
if err != nil {
log.Fatal(err)
}
assert := assert.New(doc)
res, err := http.Get("https://petstore.swagger.io/v2/pet/111111422")
if err != nil {
log.Fatal(err)
}
log.Println(assert.Response(res))
}Examples
- Simple example with Echo Framework
Development
Requirements
- Install Go
- Install GolangCI-Lint - Linter
Makefile
# Clean up
$ make clean
# Download project dependencies
$ make configure
# Run tests and generates html coverage file
$ make cover
# Format all go files
$ make fmt
# GolangCI-Lint
$ make lint
# Run tests
$make testLicense
This project is released under the MIT licence. See LICENSE for more details.