killgrave

README

Killgrave

Killgrave is a simulator for HTTP-based APIs, in simple words a Mock Server, very easy to use made in Go.

Getting started

Install killgrave using go:

$ GO111MODULE=off go get -u github.com/friendsofgo/killgrave/cmd/killgrave

Install killgrave using homebrew:

$ brew install friendsofgo/tap/killgrave

Or you can download the binary for your arch on:

https://github.com/friendsofgo/killgrave/releases

Using Killgrave

Use killgrave with default flags:

$ killgrave
2019/04/14 23:53:26 The fake server is on tap now: http://localhost:3000

Or custome your server with this flags:

 -host string
        if you run your server on a different host (default "localhost")
 -imposters string
        directory where your imposter are saved (default "imposters")
 -port int
        por to run the server (default 3000)
 -version
        show the version of the application

How to use

Create an imposter

You must be create an imposter to start to use the application

imposters/create_gopher.json

{
    "request": {
        "method": "POST",
        "endpoint": "/gophers",
        "schema_file": "schemas/create_gopher_request.json",
        "headers": {
            "Content-Type": [
                "application/json"
            ]
        }
    },
    "response": {
        "status": 200,
        "headers": {
            "Content-Type": [
                "application/json"
            ]
        },
        "bodyFile": "responses/create_gopher_response.json"
    }
}

And its related files

schemas/create_gopher_request.json
{
    "type": "object",
    "properties": {
        "data": {
            "type": "object",
            "properties": {
                "type": {
                    "type": "string",
                    "enum": [
                        "gophers"
                    ]
                },
                "attributes": {
                    "type": "object",
                    "properties": {
                        "name": {
                            "type": "string"
                        },
                        "color": {
                            "type": "string"
                        },
                        "age": {
                            "type": "integer"
                        }
                    },
                    "required": [
                        "name",
                        "color",
                        "age"
                    ]
                }
            },
            "required": [
                "type",
                "attributes"
            ]
        }
    },
    "required": [
        "data"
    ]
}

responses/create_gopher_response.json
{
    "data": {
        "type": "gophers",
        "id": "01D8EMQ185CA8PRGE20DKZTGSR",
        "attributes": {
            "name": "Zebediah",
            "color": "Purple",
            "age": 55
        }
    }
}

And then with the server on tap you can execute your request:

curl --header "Content-Type: application/json" \
  --request POST \
  --data '{
            "data": {
                "type": "gophers",
                "attributes": {
                "name": "Zebediah",
                "color": "Purple",
                "age": 55
                }
            }
    }' \
  http://localhost:3000/gophers

Docker

The application is also available through Docker, just run:

docker run -it --rm -p 3000:3000 friendsofgo/killgrave

Remember to use the -p flag to expose the container port where the application is listening (3000 by default).

NOTE: If you want to use killgrave through Docker at the same time you use your own dockerised HTTP-based API, be careful with networking issues.

Features

• Imposters created in json
• Validate json schemas on requests
• Validate requests headers
• Check response status
• All content-type bodies
• Write body files (XML, JSON, HTML...)
• Write bodies in line
• Regex for using on endpoint urls
• Allow write headers on response
• Allow imposter's matching by request schema
• Dynamic responses based on regex endpoint or request schema

Next Features

• Dynamic responses based on headers
• Dynamic responses based on query params
• Allow write multiples imposters by file
• Proxy server
• Record proxy server
• Better documentation with examples of each feature

Contributing

Contributions are more than welcome, if you are interested please fork this repo and send your Pull Request.

License

MIT License, see LICENSE

Documentation

Index

• func ImposterHandler(imposter Imposter) http.HandlerFunc
• func MatcherBySchema(imposter Imposter) mux.MatcherFunc
• type Imposter
  • func (i *Imposter) CalculateFilePath(filePath string) string
• type Request
• type Response
• type Server
  • func NewServer(p string, r *mux.Router) *Server
  • func (s *Server) Run() error

Functions

func ImposterHandler

func ImposterHandler(imposter Imposter) http.HandlerFunc

ImposterHandler create specific handler for the received imposter

func MatcherBySchema

func MatcherBySchema(imposter Imposter) mux.MatcherFunc

MatcherBySchema check if the request matching with the schema file

Types

type Imposter

type Imposter struct {
	BasePath string
	Request  Request  `json:"request"`
	Response Response `json:"response"`
}

Imposter define an imposter structure

func (*Imposter) CalculateFilePath

func (i *Imposter) CalculateFilePath(filePath string) string

CalculateFilePath calculate file path based on basePath of imposter directory

type Request

type Request struct {
	Method     string       `json:"method"`
	Endpoint   string       `json:"endpoint"`
	SchemaFile *string      `json:"schema_file"`
	Headers    *http.Header `json:"headers"`
}

Request represent the structure of real request

type Response

type Response struct {
	Status   int          `json:"status"`
	Body     string       `json:"body"`
	BodyFile *string      `json:"bodyFile"`
	Headers  *http.Header `json:"headers"`
}

Response represent the structure of real response

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server definition of mock server

func NewServer

func NewServer(p string, r *mux.Router) *Server

NewServer initialize the mock server

func (*Server) Run

func (s *Server) Run() error

Run read all the files on the impostersPath and creates different handlers for each imposter