Concepts
Imposters
Imposters are the most important concept in the Killgrave's world.
They conform the rules that determine how the mock server should respond to a request.
You can identify a Killgrave imposter file by its extension: .imp.json, .imp.yml or .imp.yaml.
Imposters Structure
The imposter object can be divided in two parts:
Request
This part defines how Killgrave should determine whether an incoming request matches the imposter or not.
The request object has the following properties:
method(mandatory): The HTTP method of the incoming request.endpoint(mandatory): Path of the endpoint relative to the base. Supports regular expressions.schemaFile: A JSON schema to validate the incoming request against.params: Restrict incoming requests by query parameters. Supports regular expressions.headers: Restrict incoming requests by HTTP header.
Response
This part defines how Killgrave should, in case of match, respond to the incoming request.
The response object has the following properties:
',10),m=t("status (mandatory): Integer defining the HTTP status code to return.body or bodyFile: The response body. Either a literal string (body) or a path to a file (bodyFile). bodyFile is especially useful in the case of large outputs. This property is optional: if not response body should be returned it should be removed or left empty.headers: HTTP headers to return in the response.Getting started
To start Killgrave, you can simply do it by running:
$ killgrave
+While you are welcome to provide your own configuration, Killgrave will default to the following configuration:
- imposters path:
imposters- host:
localhost- port:
3000- CORS:
[]- proxy:
none- watcher:
false- debugger:
- enabled:
false- address:
localhost:3030
Command-line interface
Killgrave is almost fully configurable through the command line, except for CORS, which can only be configured using the config file.
You can find the list with all the available flags at CLI section or by running:
$ killgrave -h
+Configuration file
In case you are looking for a predictable and reproducible configuration, you can use the -config command-line flag to specify the location of a configuration file, which can be written either in JSON or YAML.
You can find the list with all the available settings at Config Reference section.
As you can see, you can configure all the options in a very easy way.
`,14),r=[n];function l(s,c){return o(),i("div",null,r)}const h=e(a,[["render",l],["__file","getting-started.html.vue"]]);export{h as default}; diff --git a/assets/getting-started.html-rmTUm9IU.js b/assets/getting-started.html-rmTUm9IU.js new file mode 100644 index 0000000..11aa0f1 --- /dev/null +++ b/assets/getting-started.html-rmTUm9IU.js @@ -0,0 +1 @@ +const e=JSON.parse('{"key":"v-fb0f0066","path":"/guide/getting-started.html","title":"Getting started","lang":"en-US","frontmatter":{"prev":"./installation","next":"./your-first-imposter"},"headers":[{"level":2,"title":"Command-line interface","slug":"command-line-interface","link":"#command-line-interface","children":[]},{"level":2,"title":"Configuration file","slug":"configuration-file","link":"#configuration-file","children":[]}],"git":{"updatedTime":1700862554000,"contributors":[{"name":"Joan López de la Franca Beltran","email":"joanjan14@gmail.com","commits":1}]},"filePathRelative":"guide/getting-started.md"}');export{e as data}; diff --git a/assets/ht-delays.html-5ziKQeRG.js b/assets/ht-delays.html-5ziKQeRG.js new file mode 100644 index 0000000..8285a2c --- /dev/null +++ b/assets/ht-delays.html-5ziKQeRG.js @@ -0,0 +1 @@ +const e=JSON.parse('{"key":"v-d5fc1798","path":"/guide/ht-delays.html","title":"Use delayed responses","lang":"en-US","frontmatter":{"prev":"./ht-json","next":"./ht-dynamic"},"headers":[],"git":{"updatedTime":1700862554000,"contributors":[{"name":"Joan López de la Franca Beltran","email":"joanjan14@gmail.com","commits":1}]},"filePathRelative":"guide/ht-delays.md"}');export{e as data}; diff --git a/assets/ht-delays.html-LuxVH0ER.js b/assets/ht-delays.html-LuxVH0ER.js new file mode 100644 index 0000000..855f199 --- /dev/null +++ b/assets/ht-delays.html-LuxVH0ER.js @@ -0,0 +1,20 @@ +import{_ as a,r as t,o,c as p,a as s,b as n,d as r,e as l}from"./app-GKjJbFgT.js";const c={},i=s("h1",{id:"use-delayed-responses",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#use-delayed-responses","aria-hidden":"true"},"#"),n(" Use delayed responses")],-1),u=s("p",null,[n("If you want to simulate a problem with the network, or create a more realistic response, you can use the "),s("code",null,"delay"),n(" property.")],-1),d=s("code",null,"delay",-1),k={href:"https://golang.org/pkg/time/#ParseDuration",target:"_blank",rel:"noopener noreferrer"},v=l(`Historically, the options
imposters_path,portandhostwere mandatory when using a configuration file. However, since the last version (v0.4.1), they are no longer needed, so you can simply override those options if you actually want to. Furthermore, in previous versions (prior tov0.4.1), theimposters_pathoption was used to refer to the path to the working directory where Killgrave was executed from, but since the last version (v0.4.1) this is relative to the location of the config file.
Alternatively, the delay property can take a range of two durations, separated by :. In this case, the server will respond with a random delay within this range.
With the example below, the response would be delayed between 1 and 5 seconds:
[
+ {
+ "request": {
+ "method": "POST",
+ "endpoint": "/gophers",
+ "schemaFile": "schemas/create_gopher_request.json",
+ "headers": {
+ "Content-Type": "application/json"
+ }
+ },
+ "response": {
+ "status": 201,
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "delay": "1s:5s"
+ }
+ }
+]
+Use dynamic responses
Killgrave allows dynamic responses. Using this feature, Killgrave can return different responses on the same endpoint.
To do this, all imposters need to be sorted from most restrictive to least. Killgrave tries to match the request with each of the imposters in sequence, stopping at the first imposter that matches the request.
In the following example, there are defined multiple imposters for the POST /gophers endpoint:
[
+ {
+ "request": {
+ "method": "POST",
+ "endpoint": "/gophers",
+ "schemaFile": "schemas/create_gopher_request.json",
+ "headers": {
+ "Content-Type": "application/json"
+ }
+ },
+ "response": {
+ "status": 201,
+ "headers": {
+ "Content-Type": "application/json"
+ }
+ }
+ },
+ {
+ "request": {
+ "method": "POST",
+ "endpoint": "/gophers"
+ },
+ "response": {
+ "status": 400,
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": "{\\"errors\\":\\"bad request\\"}"
+ }
+ }
+]
+Now,
- Let's say an incoming request does not match the JSON schema specified in the first imposter's
schemaFile. - Therefore, Killgrave skips this imposter and tries to match the request against the next configured imposter.
- The next configured imposter is much less restrictive, so the request matches and the associated response is returned.
To do that you will need to define our json schema first:
e.g. imposters/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"
+ ]
+}
+With this json schema, we expect a request like this:
{
+ "data": {
+ "type": "gophers",
+ "attributes": {
+ "name": "Zebediah",
+ "color": "Purples",
+ "age": 55
+ }
+ }
+}
+Then the imposter could be configured as follows:
[
+ {
+ "request": {
+ "method": "POST",
+ "endpoint": "/gophers",
+ "schemaFile": "schemas/create_gopher_request.json",
+ "headers": {
+ "Content-Type": "application/json"
+ }
+ },
+ "response": {
+ "status": 201,
+ "headers": {
+ "Content-Type": "application/json"
+ }
+ }
+ }
+]
+The path where the schema is located is relative to where the imposters are.
`,8);function k(v,q){const a=e("ExternalLinkIcon");return o(),p("div",null,[l,s("p",null,[n("Sometimes you may need to validate requests more thoroughly. In such case, you can create an imposter that only matches with a valid "),s("a",r,[n("json schema"),c(a)]),n(".")]),d])}const b=t(u,[["render",k],["__file","ht-json.html.vue"]]);export{b as default}; diff --git a/assets/ht-json.html-INXtboAi.js b/assets/ht-json.html-INXtboAi.js new file mode 100644 index 0000000..6ef6e9f --- /dev/null +++ b/assets/ht-json.html-INXtboAi.js @@ -0,0 +1 @@ +const e=JSON.parse('{"key":"v-5cac6c5c","path":"/guide/ht-json.html","title":"Use JSON Schema","lang":"en-US","frontmatter":{"prev":"./ht-regex","next":"./ht-delays"},"headers":[],"git":{"updatedTime":1700862554000,"contributors":[{"name":"Joan López de la Franca Beltran","email":"joanjan14@gmail.com","commits":1}]},"filePathRelative":"guide/ht-json.md"}');export{e as data}; diff --git a/assets/ht-regex.html-NdAzqI34.js b/assets/ht-regex.html-NdAzqI34.js new file mode 100644 index 0000000..d86d0a2 --- /dev/null +++ b/assets/ht-regex.html-NdAzqI34.js @@ -0,0 +1,52 @@ +import{_ as o,r as p,o as u,c as r,a as s,b as n,d as e,e as t}from"./app-GKjJbFgT.js";const i={},l=s("h1",{id:"use-regular-expressions-regex",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#use-regular-expressions-regex","aria-hidden":"true"},"#"),n(" Use regular expressions (regex)")],-1),c=s("h2",{id:"regex-in-the-endpoint",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#regex-in-the-endpoint","aria-hidden":"true"},"#"),n(" Regex in the endpoint")],-1),d={href:"https://github.com/gorilla/mux",target:"_blank",rel:"noopener noreferrer"},q={href:"https://cran.r-project.org/web/packages/ulid/vignettes/intro-to-ulid.html",target:"_blank",rel:"noopener noreferrer"},k=t(`[
+ {
+ "request": {
+ "method": "GET",
+ "endpoint": "/gophers/{_id:[\\\\w]{26}}"
+ },
+ "response": {
+ "status": 200,
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": "{\\"data\\":{\\"type\\":\\"gophers\\",\\"id\\":\\"01D8EMQ185CA8PRGE20DKZTGSR\\",\\"attributes\\":{\\"name\\":\\"Zebediah\\",\\"color\\":\\"Purples\\",\\"age\\":55}}}"
+ }
+ }
+]
+Regex in the query parameters
`,2),v={href:"https://github.com/gorilla/mux",target:"_blank",rel:"noopener noreferrer"},m=t(`In this example, we have configured an imposter that only matches if we receive an apiKey as query parameter:
[
+ {
+ "request": {
+ "method": "GET",
+ "endpoint": "/gophers/{_id:[\\\\w]{26}}",
+ "params": {
+ "apiKey": "{_apiKey:[\\\\w]+}"
+ }
+ },
+ "response": {
+ "status": 200,
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": "{\\"data\\":{\\"type\\":\\"gophers\\",\\"id\\":\\"01D8EMQ185CA8PRGE20DKZTGSR\\",\\"attributes\\":{\\"name\\":\\"Zebediah\\",\\"color\\":\\"Purples\\",\\"age\\":55}}}"
+ }
+ }
+]
+Regex in the headers:
In this case we will not need the gorilla mux nomenclature to write our regex.
In the next example, we have configured an imposter that uses regex to match an Authorization header.
[
+ {
+ "request": {
+ "method": "GET",
+ "endpoint": "/gophers/{id:[\\\\w]{26}}",
+ "headers": {
+ "Authorization": "\\\\w+"
+ }
+ },
+ "response": {
+ "status": 200,
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": "{\\"data\\":{\\"type\\":\\"gophers\\",\\"id\\":\\"01D8EMQ185CA8PRGE20DKZTGSR\\",\\"attributes\\":{\\"name\\":\\"Zebediah\\",\\"color\\":\\"Purples\\",\\"age\\":55}}}"
+ }
+ }
+]
+Killgrave
Killgrave can be used without explicitly providing any configuration. However, you can tune up some of their settings like the host and port where the mock server is listening to, among others, by providing some configuration settings.
To provide those settings, you can either use the available CLI flags or use the -config flag to provide the path to a settings file. In such case, you can either use JSON or YAML.
Basic
Minimal configuration attributes needed to get your mock up and running.
host
- Type:
string - Default:
localhost
{
+ "host": "localhost"
+}
+host: "localhost"
+port
- Type:
number - Default:
3000
{
+ "port": 3000
+}
+port: 3000
+imposters_path
- Type:
string - Default:
imposters
Specify the directory the imposter files (either .imp.json, .imp.yml or .imp.yaml) will be loaded from. On a regular set up, this directory will contain multiple of those imposter files and the directories with schemas and responses.
{
+ "imposters_path": "imposters"
+}
+imposters_path: imposters
+Proxy
Set up a proxy to redirect the incoming requests as you want.
mode
- Type:
string - Default:
none
Specify the proxy mode for the Killgrave server. The default value is none which means no proxy. Use missing to redirect only those incoming requests that aren't defined within the imposters. Use all to redirect all incoming requests.
{
+ "proxy": {
+ "mode": "missing"
+ }
+}
+proxy:
+ mode: missing
+url
- Type:
string - Default: -
Specify the url for the Killgrave's proxy. The incoming requests will be redirected to this url based on the proxy mode.
{
+ "proxy": {
+ "url": "https://example.com"
+ }
+}
+proxy:
+ url: https://example.com
+CORS
`,20),g={href:"https://developer.mozilla.org/docs/Web/HTTP/CORS",target:"_blank",rel:"noopener noreferrer"},y=a(`methods
- Type:
string array - Default:
["GET", "HEAD", "POST", "PUT", "OPTIONS", "DELETE", "PATCH", "TRACE", "CONNECT"]
Represents the Access-Control-Request-Method header.
{
+ "cors": {
+ "methods": ["GET"]
+ }
+}
+cors:
+ methods: ["GET"]
+headers
- Type:
string array - Default:
["X-Requested-With", "Content-Type", "Authorization"]
Represents the Access-Control-Request-Headers header.
{
+ "cors": {
+ "headers": ["Content-Type"]
+ }
+}
+cors:
+ headers: ["Content-Type"]
+exposed_headers
- Type:
string array - Default:
["Cache-Control", "Content-Language", "Content-Type", "Expires", "Last-Modified", "Pragma"]
Represents the Access-Control-Expose-Headers header.
{
+ "cors": {
+ "exposed_headers": ["Cache-Control"]
+ }
+}
+cors:
+ exposed_headers: ["Cache-Control"]
+origins
- Type:
string array - Default:
[]
Represents the Access-Control-Allow-Origin header.
{
+ "cors": {
+ "origins": ["*"]
+ }
+}
+cors:
+ origins: ["*"]
+allow_credentials
- Type:
boolean - Default:
false
Enables or disables the Access-Control-Allow-Credentials header.
{
+ "cors": {
+ "allow_credentials": true
+ }
+}
+cors:
+ allow_credentials: true
+Security
Sometimes you may want to simulate a production-like behavior with your mock servers, for instance to verify that your frontend application manages correctly HTTPS/TLS connections.
secure
- Type:
boolean - Default:
false
Expose the mock server through HTTP over TLS(SSL).
{
+ "secure": true
+}
+secure: true
+Hot reloads
When building the imposters to mock your server, you way want to reduce the feedback loop on configuration changes.
watcher
- Type:
boolean - Default:
false
Enable the file watcher to hot reload the mock server on every imposters change.
{
+ "watcher": true
+}
+watcher: true
+Full example
See below a full example of the configuration file:
{
+ "port": 3000,
+ "host": "localhost",
+ "imposters_path": "imposters",
+ "proxy": {
+ "url": "https://example.com",
+ "mode": "missing"
+ },
+ "cors": {
+ "methods": [
+ "GET"
+ ],
+ "headers": [
+ "Content-Type"
+ ],
+ "exposed_headers": [
+ "Cache-Control"
+ ],
+ "origins": [
+ "*"
+ ],
+ "allow_credentials": true
+ },
+ "secure": true,
+ "watcher": true
+}
+port: 3000
+host: "localhost"
+imposters_path: "imposters"
+proxy:
+ url: https://example.com
+ mode: missing
+cors:
+ methods: ["GET"]
+ headers: ["Content-Type"]
+ exposed_headers: ["Cache-Control"]
+ origins: ["*"]
+ allow_credentials: true
+secure: true
+watcher: true
+Imposters
Imposters are the first-class citizens in Killgrave, they define how the mock server will respond to the incoming requests. You can use either JSON or YAML to define them.
Request
The request configuration is used to evaluate whether an incoming request matches the imposter or not. If there's a match, the mock server will respond with the imposter's response.
method
- Type:
string - Default: -
Specify the expected HTTP method.
{
+ "request": {
+ "method": "POST"
+ }
+}
+request:
+ method: "POST"
+endpoint
- Type:
string - Default: -
{
+ "request": {
+ "endpoint": "/gophers"
+ }
+}
+request:
+ endpoint: /gophers
+schemaFile
- Type:
string - Default: -
Specify the path to the file that contains the expected JSON schema.
{
+ "request": {
+ "schemaFile": "schemas/create_gopher_request.json"
+ }
+}
+request:
+ schemaFile: "schemas/create_gopher_request.json"
+params
- Type:
string map - Default: -
{
+ "request": {
+ "params": {
+ "id": "01EKPT"
+ }
+ }
+}
+request:
+ params:
+ id: "01EKPT"
+headers
- Type:
string map - Default: -
Specify the expected HTTP headers.
{
+ "request": {
+ "headers": {
+ "Content-Type": "application/json",
+ "Return-Error": "error"
+ }
+ }
+}
+request:
+ headers:
+ Content-Type: "application/json"
+ Return-Error: "error"
+Response
The response configuration is used to build the response in case of match with the incoming request.
status
- Type:
number - Default:
200
Specify the response's HTTP status code.
{
+ "response": {
+ "status": 401
+ }
+}
+response:
+ status: 401
+body
- Type:
string - Default: -
Specify the raw contents (as string) to be returned as the response body. You could use a stringified JSON, for instance.
Although, in such cases where the desired response body is a complex payload (e.g. a JSON object), we recommend to use a separate file in combination with the bodyFile request attribute.
{
+ "response": {
+ "body": "Simple response body"
+ }
+}
+response:
+ body: "Simple response body"
+bodyFile
- Type:
string - Default: -
Specify the path to the file that contains the response body's contents.
{
+ "response": {
+ "bodyFile": "/path/to/file"
+ }
+}
+response:
+ bodyFile: "/path/to/file"
+headers
- Type:
string map - Default: -
Specify the response's HTTP headers.
{
+ "response": {
+ "headers": {
+ "Content-Type": "application/json",
+ "Return-Error": "error"
+ }
+ }
+}
+response:
+ headers:
+ Content-Type: "application/json"
+ Return-Error: "error"
+delay
- Type:
string - Default: -
Specify the response delay. It is really helpful to reproduce real-world examples and/or to simulate situations with peaks of load where the responses are considerably slow.
You can use either a fixed time (single value) or an interval (two values joined by :).
{
+ "response": {
+ "delay": "2s:5s"
+ }
+}
+response:
+ delay: "2s:5s"
+Full examples
See below some full examples:
Request
{
+ "request": {
+ "method": "POST",
+ "endpoint": "/gophers",
+ "schemaFile": "schemas/create_gopher_request.json",
+ "params": {
+ "id": "01EKPT"
+ },
+ "headers": {
+ "Content-Type": "application/json",
+ "Return-Error": "error"
+ }
+ }
+}
+request:
+ method: "POST"
+ endpoint: "/gophers"
+ schemaFile": "schemas/create_gopher_request.json"
+ params":
+ id: "01EKPT"
+ headers:
+ Content-Type: "application/json"
+ Return-Error: "error"
+Response
{
+ "response": {
+ "status": 401,
+ "body": "Simple response body",
+ "bodyFile": "/path/to/file",
+ "headers": {
+ "Content-Type": "application/json",
+ "Return-Error": "error"
+ },
+ "delay": "2s:5s"
+ }
+}
+response:
+ status: 401
+ body: "Simple response body"
+ bodyFile: "/path/to/file"
+ headers:
+ Content-Type: "application/json"
+ Return-Error: "error"
+ delay: "2s:5s"
+Note from the examples above that you should only provide one of body or bodyFile, but not both. Here both are defined just for the sake of showing a full example.
Killgrave is a tool that provides a simple way to create a powerful simulator for HTTP-based APIs.
The Killgrave's philosophy is to provide an easy way to configure your mock server, ensuring that you don't need to learn another tooling language. For that reason we use JSON and YAML to generate all necessary configurations.
Some Killgrave features are:
- An easy way to create imposters files, either using JSON or YAML.
- The possibility to validate requests against JSON schemas.
- Use of regular expressions to allow different parameters in headers and urls.
- Custom and dynamic response bodies, of all content types (application/json, text/html...).
- Custom response headers and cross-origin resource sharing (CORS).
- Simulate network issues and server high loads with configurable, dynamic responses delay.
- Use of configurable proxy server to call to the original server.
- Use either command-line interface flags or a configuration file (JSON/YAML).
- Hot configuration reloads based on a configurable file watcher.
- Expose the mocker server through HTTP over TLS (SSL).
- Use of an interactive mode to debug your mock server with a web app.
However, you can tune up some of their settings like the host and port where the mock server is listening to, among others, by providing some configuration settings.
To provide those settings, you can either use the available CLI flags or use the -config flag to provide the path to a settings file. In such case, you can either use a JSON or YAML configuration file.
Available flags
See below the list of available flags:
$ killgrave -h
+
+ -config string
+ path to the configuration file
+ -debugger
+ run your server with the debugger
+ -debugger-addr string
+ debugger address (default "localhost:3030")
+ -host string
+ run your server on a different host (default "localhost")
+ -imposters string
+ directory where imposters are read from (default "imposters")
+ -port int
+ run your server on a different port (default 3000)
+ -proxy-mode string
+ proxy mode (choose between 'all', 'missing' or 'none') (default "none")
+ -proxy-url string
+ proxy url, use it in combination with proxy-mode
+ -secure
+ run your server using TLS (https)
+ -version
+ show the version of the application
+ -watcher
+ enable the file watcher, which reloads the server on every file change
+You can install Killgrave in different ways, but all of them are very simple:
Go Toolchain
One of them is of course using go install, Killgrave is a Go project and therefore can be compiled using the go toolchain:
$ go install github.com/friendsofgo/killgrave/cmd/killgrave@{version}
+Note that version must be replaced by the version that you want to install. If left unspecified, the main branch will be installed.
Homebrew
`,6),u={href:"https://brew.sh/",target:"_blank",rel:"noopener noreferrer"},b=o(`$ brew install friendsofgo/tap/killgrave
+⚠️ If you are installing via Homebrew, you always get the latest Killgrave version, we hope to fix this soon!
Docker
`,3),m={href:"https://www.docker.com/",target:"_blank",rel:"noopener noreferrer"},g=o(`$ docker run -it --rm -p 3000:3000 -v $PWD/:/home -w /home friendsofgo/killgrave -host 0.0.0.0
+-p 3000:3000is used to forward the local port3000(Killgrave's default port) to container's port3000, otherwise Killgrave won't be reachable from the host.-host 0.0.0.0is used to change the Killgrave's default host (localhost) to allow Killgrave to listen to and respond to incoming requests from outside the container, otherwise Killgrave won't be reachable from the host.
Other
`,3),v={href:"https://github.com/friendsofgo/killgrave/releases",target:"_blank",rel:"noopener noreferrer"};function f(k,_){const n=t("ExternalLinkIcon");return i(),l("div",null,[d,a("blockquote",null,[a("p",null,[e("⚠️ Even though Killgrave is a very robust tool and is being used by some companies in production environments, it's still in initial development. Therefore, 'minor' version numbers are used to signify breaking changes and 'patch' version numbers are used for non-breaking changes or bugfixing. As soon as v1.0.0 is released, Killgrave will start to use "),a("a",h,[e("SemVer"),s(n)]),e(" as usual.")])]),p,a("p",null,[e("If you are a macOS user, you can install Killgrave using "),a("a",u,[e("Homebrew"),s(n)]),e(":")]),b,a("p",null,[e("Killgrave is also available through "),a("a",m,[e("Docker"),s(n)]),e(".")]),g,a("p",null,[e("Windows and Linux users can download binaries from the "),a("a",v,[e("GitHub Releases"),s(n)]),e(" page.")])])}const x=r(c,[["render",f],["__file","installation.html.vue"]]);export{x as default}; diff --git a/assets/style-ysdZ3Cf_.css b/assets/style-ysdZ3Cf_.css new file mode 100644 index 0000000..98e5de9 --- /dev/null +++ b/assets/style-ysdZ3Cf_.css @@ -0,0 +1 @@ +:root{--back-to-top-z-index: 5;--back-to-top-color: #3eaf7c;--back-to-top-color-hover: #71cda3}.back-to-top{cursor:pointer;position:fixed;bottom:2rem;right:2.5rem;width:2rem;height:1.2rem;background-color:var(--back-to-top-color);-webkit-mask:url("data:image/svg+xml,%3csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2049.484%2028.284'%3e%3cg%20transform='translate(-229%20-126.358)'%20fill='currentColor'%3e%3crect%20width='35'%20height='5'%20rx='2'%20transform='rotate(-45%20296.902%20-200.874)'/%3e%3crect%20width='35'%20height='5'%20rx='2'%20transform='rotate(-135%20169.502%2020.377)'/%3e%3c/g%3e%3c/svg%3e") no-repeat;mask:url("data:image/svg+xml,%3csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2049.484%2028.284'%3e%3cg%20transform='translate(-229%20-126.358)'%20fill='currentColor'%3e%3crect%20width='35'%20height='5'%20rx='2'%20transform='rotate(-45%20296.902%20-200.874)'/%3e%3crect%20width='35'%20height='5'%20rx='2'%20transform='rotate(-135%20169.502%2020.377)'/%3e%3c/g%3e%3c/svg%3e") no-repeat;z-index:var(--back-to-top-z-index)}.back-to-top:hover{background-color:var(--back-to-top-color-hover)}@media (max-width: 959px){.back-to-top{display:none}}@media print{.back-to-top{display:none}}.back-to-top-enter-active,.back-to-top-leave-active{transition:opacity .3s}.back-to-top-enter-from,.back-to-top-leave-to{opacity:0}:root{--external-link-icon-color: #aaa}.external-link-icon{position:relative;display:inline-block;color:var(--external-link-icon-color);vertical-align:middle;top:-1px}@media print{.external-link-icon{display:none}}.external-link-icon-sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border-width:0;-webkit-user-select:none;-moz-user-select:none;user-select:none}:root{--medium-zoom-z-index: 100;--medium-zoom-bg-color: #ffffff;--medium-zoom-opacity: 1}.medium-zoom-overlay{background-color:var(--medium-zoom-bg-color)!important;z-index:var(--medium-zoom-z-index)}.medium-zoom-overlay~img{z-index:calc(var(--medium-zoom-z-index) + 1)}.medium-zoom--opened .medium-zoom-overlay{opacity:var(--medium-zoom-opacity)}:root{--nprogress-color: #29d;--nprogress-z-index: 1031}#nprogress{pointer-events:none}#nprogress .bar{background:var(--nprogress-color);position:fixed;z-index:var(--nprogress-z-index);top:0;left:0;width:100%;height:2px}:root{--c-brand: #3eaf7c;--c-brand-light: #4abf8a;--c-bg: #ffffff;--c-bg-light: #f3f4f5;--c-bg-lighter: #eeeeee;--c-bg-dark: #ebebec;--c-bg-darker: #e6e6e6;--c-bg-navbar: var(--c-bg);--c-bg-sidebar: var(--c-bg);--c-bg-arrow: #cccccc;--c-text: #2c3e50;--c-text-accent: var(--c-brand);--c-text-light: #3a5169;--c-text-lighter: #4e6e8e;--c-text-lightest: #6a8bad;--c-text-quote: #999999;--c-border: #eaecef;--c-border-dark: #dfe2e5;--c-tip: #42b983;--c-tip-bg: var(--c-bg-light);--c-tip-title: var(--c-text);--c-tip-text: var(--c-text);--c-tip-text-accent: var(--c-text-accent);--c-warning: #ffc310;--c-warning-bg: #fffae3;--c-warning-bg-light: #fff3ba;--c-warning-bg-lighter: #fff0b0;--c-warning-border-dark: #f7dc91;--c-warning-details-bg: #fff5ca;--c-warning-title: #f1b300;--c-warning-text: #746000;--c-warning-text-accent: #edb100;--c-warning-text-light: #c1971c;--c-warning-text-quote: #ccab49;--c-danger: #f11e37;--c-danger-bg: #ffe0e0;--c-danger-bg-light: #ffcfde;--c-danger-bg-lighter: #ffc9c9;--c-danger-border-dark: #f1abab;--c-danger-details-bg: #ffd4d4;--c-danger-title: #ed1e2c;--c-danger-text: #660000;--c-danger-text-accent: #bd1a1a;--c-danger-text-light: #b5474d;--c-danger-text-quote: #c15b5b;--c-details-bg: #eeeeee;--c-badge-tip: var(--c-tip);--c-badge-warning: #ecc808;--c-badge-warning-text: var(--c-bg);--c-badge-danger: #dc2626;--c-badge-danger-text: var(--c-bg);--t-color: .3s ease;--t-transform: .3s ease;--code-bg-color: #282c34;--code-hl-bg-color: rgba(0, 0, 0, .66);--code-ln-color: #9e9e9e;--code-ln-wrapper-width: 3.5rem;--font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif;--font-family-code: Consolas, Monaco, "Andale Mono", "Ubuntu Mono", monospace;--navbar-height: 3.6rem;--navbar-padding-v: .7rem;--navbar-padding-h: 1.5rem;--sidebar-width: 20rem;--sidebar-width-mobile: calc(var(--sidebar-width) * .82);--content-width: 740px;--homepage-width: 960px}.back-to-top{--back-to-top-color: var(--c-brand);--back-to-top-color-hover: var(--c-brand-light)}.DocSearch{--docsearch-primary-color: var(--c-brand);--docsearch-text-color: var(--c-text);--docsearch-highlight-color: var(--c-brand);--docsearch-muted-color: var(--c-text-quote);--docsearch-container-background: rgba(9, 10, 17, .8);--docsearch-modal-background: var(--c-bg-light);--docsearch-searchbox-background: var(--c-bg-lighter);--docsearch-searchbox-focus-background: var(--c-bg);--docsearch-searchbox-shadow: inset 0 0 0 2px var(--c-brand);--docsearch-hit-color: var(--c-text-light);--docsearch-hit-active-color: var(--c-bg);--docsearch-hit-background: var(--c-bg);--docsearch-hit-shadow: 0 1px 3px 0 var(--c-border-dark);--docsearch-footer-background: var(--c-bg)}.external-link-icon{--external-link-icon-color: var(--c-text-quote)}.medium-zoom-overlay{--medium-zoom-bg-color: var(--c-bg)}#nprogress{--nprogress-color: var(--c-brand)}.pwa-popup{--pwa-popup-text-color: var(--c-text);--pwa-popup-bg-color: var(--c-bg);--pwa-popup-border-color: var(--c-brand);--pwa-popup-shadow: 0 4px 16px var(--c-brand);--pwa-popup-btn-text-color: var(--c-bg);--pwa-popup-btn-bg-color: var(--c-brand);--pwa-popup-btn-hover-bg-color: var(--c-brand-light)}.search-box{--search-bg-color: var(--c-bg);--search-accent-color: var(--c-brand);--search-text-color: var(--c-text);--search-border-color: var(--c-border);--search-item-text-color: var(--c-text-lighter);--search-item-focus-bg-color: var(--c-bg-light)}html.dark{--c-brand: #3aa675;--c-brand-light: #349469;--c-bg: #22272e;--c-bg-light: #2b313a;--c-bg-lighter: #262c34;--c-bg-dark: #343b44;--c-bg-darker: #37404c;--c-text: #adbac7;--c-text-light: #96a7b7;--c-text-lighter: #8b9eb0;--c-text-lightest: #8094a8;--c-border: #3e4c5a;--c-border-dark: #34404c;--c-tip: #318a62;--c-warning: #e0ad15;--c-warning-bg: #2d2f2d;--c-warning-bg-light: #423e2a;--c-warning-bg-lighter: #44442f;--c-warning-border-dark: #957c35;--c-warning-details-bg: #39392d;--c-warning-title: #fdca31;--c-warning-text: #d8d96d;--c-warning-text-accent: #ffbf00;--c-warning-text-light: #ddb84b;--c-warning-text-quote: #ccab49;--c-danger: #fc1e38;--c-danger-bg: #39232c;--c-danger-bg-light: #4b2b35;--c-danger-bg-lighter: #553040;--c-danger-border-dark: #a25151;--c-danger-details-bg: #482936;--c-danger-title: #fc2d3b;--c-danger-text: #ea9ca0;--c-danger-text-accent: #fd3636;--c-danger-text-light: #d9777c;--c-danger-text-quote: #d56b6b;--c-details-bg: #323843;--c-badge-warning: var(--c-warning);--c-badge-warning-text: #3c2e05;--c-badge-danger: var(--c-danger);--c-badge-danger-text: #401416;--code-hl-bg-color: #363b46}html.dark .DocSearch{--docsearch-logo-color: var(--c-text);--docsearch-modal-shadow: inset 1px 1px 0 0 #2c2e40, 0 3px 8px 0 #000309;--docsearch-key-shadow: inset 0 -2px 0 0 #282d55, inset 0 0 1px 1px #51577d, 0 2px 2px 0 rgba(3, 4, 9, .3);--docsearch-key-gradient: linear-gradient(-225deg, #444950, #1c1e21);--docsearch-footer-shadow: inset 0 1px 0 0 rgba(73, 76, 106, .5), 0 -4px 8px 0 rgba(0, 0, 0, .2)}html,body{padding:0;margin:0;background-color:var(--c-bg);transition:background-color var(--t-color)}html.dark{color-scheme:dark}html{font-size:16px}body{font-family:var(--font-family);-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;font-size:1rem;color:var(--c-text)}a{font-weight:500;color:var(--c-text-accent);text-decoration:none;overflow-wrap:break-word}p a code{font-weight:400;color:var(--c-text-accent)}kbd{font-family:var(--font-family-code);color:var(--c-text);background:var(--c-bg-lighter);border:solid .15rem var(--c-border-dark);border-bottom:solid .25rem var(--c-border-dark);border-radius:.15rem;padding:0 .15em}code{font-family:var(--font-family-code);color:var(--c-text-lighter);padding:.25rem .5rem;margin:0;font-size:.85em;background-color:var(--c-bg-light);border-radius:3px;overflow-wrap:break-word;transition:background-color var(--t-color)}blockquote{font-size:1rem;color:var(--c-text-quote);border-left:.2rem solid var(--c-border-dark);margin:1rem 0;padding:.25rem 0 .25rem 1rem;overflow-wrap:break-word}blockquote>p{margin:0}ul,ol{padding-left:1.2em}strong{font-weight:600}h1,h2,h3,h4,h5,h6{font-weight:600;line-height:1.25;overflow-wrap:break-word}h1:focus-visible,h2:focus-visible,h3:focus-visible,h4:focus-visible,h5:focus-visible,h6:focus-visible{outline:none}h1:hover .header-anchor,h2:hover .header-anchor,h3:hover .header-anchor,h4:hover .header-anchor,h5:hover .header-anchor,h6:hover .header-anchor{opacity:1}h1{font-size:2.2rem}h2{font-size:1.65rem;padding-bottom:.3rem;border-bottom:1px solid var(--c-border);transition:border-color var(--t-color)}h3{font-size:1.35rem}h4{font-size:1.15rem}h5{font-size:1.05rem}h6{font-size:1rem}a.header-anchor{font-size:.85em;float:left;margin-left:-.87em;padding-right:.23em;margin-top:.125em;opacity:0;-webkit-user-select:none;-moz-user-select:none;user-select:none}@media print{a.header-anchor{display:none}}a.header-anchor:hover{text-decoration:none}a.header-anchor:focus-visible{opacity:1}@media print{a[href^="http://"]:after,a[href^="https://"]:after{content:" (" attr(href) ") "}}p,ul,ol{line-height:1.7;overflow-wrap:break-word}hr{border:0;border-top:1px solid var(--c-border)}table{border-collapse:collapse;margin:1rem 0;display:block;overflow-x:auto;transition:border-color var(--t-color)}tr{border-top:1px solid var(--c-border-dark);transition:border-color var(--t-color)}tr:nth-child(2n){background-color:var(--c-bg-light);transition:background-color var(--t-color)}tr:nth-child(2n) code{background-color:var(--c-bg-dark)}th,td{padding:.6em 1em;border:1px solid var(--c-border-dark);transition:border-color var(--t-color)}.arrow{display:inline-block;width:0;height:0}.arrow.up{border-left:4px solid transparent;border-right:4px solid transparent;border-bottom:6px solid var(--c-bg-arrow)}.arrow.down{border-left:4px solid transparent;border-right:4px solid transparent;border-top:6px solid var(--c-bg-arrow)}.arrow.right{border-top:4px solid transparent;border-bottom:4px solid transparent;border-left:6px solid var(--c-bg-arrow)}.arrow.left{border-top:4px solid transparent;border-bottom:4px solid transparent;border-right:6px solid var(--c-bg-arrow)}.badge{display:inline-block;font-size:14px;font-weight:600;height:18px;line-height:18px;border-radius:3px;padding:0 6px;color:var(--c-bg);vertical-align:top;transition:color var(--t-color),background-color var(--t-color)}.badge.tip{background-color:var(--c-badge-tip)}.badge.warning{background-color:var(--c-badge-warning);color:var(--c-badge-warning-text)}.badge.danger{background-color:var(--c-badge-danger);color:var(--c-badge-danger-text)}.badge+.badge{margin-left:5px}code[class*=language-],pre[class*=language-]{color:#ccc;background:none;font-family:var(--font-family-code);font-size:1em;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;hyphens:none}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto}:not(pre)>code[class*=language-],pre[class*=language-]{background:#2d2d2d}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}.token.comment,.token.block-comment,.token.prolog,.token.doctype,.token.cdata{color:#999}.token.punctuation{color:#ccc}.token.tag,.token.attr-name,.token.namespace,.token.deleted{color:#ec5975}.token.function-name{color:#6196cc}.token.boolean,.token.number,.token.function{color:#f08d49}.token.property,.token.class-name,.token.constant,.token.symbol{color:#f8c555}.token.selector,.token.important,.token.atrule,.token.keyword,.token.builtin{color:#cc99cd}.token.string,.token.char,.token.attr-value,.token.regex,.token.variable{color:#7ec699}.token.operator,.token.entity,.token.url{color:#67cdcc}.token.important,.token.bold{font-weight:700}.token.italic{font-style:italic}.token.entity{cursor:help}.token.inserted{color:#3eaf7c}.theme-default-content pre,.theme-default-content pre[class*=language-]{line-height:1.375;padding:1.3rem 1.5rem;margin:.85rem 0;border-radius:6px;overflow:auto}.theme-default-content pre code,.theme-default-content pre[class*=language-] code{color:#fff;padding:0;background-color:transparent!important;border-radius:0;overflow-wrap:unset;-webkit-font-smoothing:auto;-moz-osx-font-smoothing:auto}.theme-default-content .line-number{font-family:var(--font-family-code)}div[class*=language-]{position:relative;background-color:var(--code-bg-color);border-radius:6px}div[class*=language-]:before{content:attr(data-ext);position:absolute;z-index:3;top:.8em;right:1em;font-size:.75rem;color:var(--code-ln-color)}div[class*=language-] pre,div[class*=language-] pre[class*=language-]{background:transparent!important;position:relative;z-index:1}div[class*=language-] .highlight-lines{-webkit-user-select:none;-moz-user-select:none;user-select:none;padding-top:1.3rem;position:absolute;top:0;left:0;width:100%;line-height:1.375}div[class*=language-] .highlight-lines .highlight-line{background-color:var(--code-hl-bg-color)}div[class*=language-]:not(.line-numbers-mode) .line-numbers{display:none}div[class*=language-].line-numbers-mode .highlight-lines .highlight-line{position:relative}div[class*=language-].line-numbers-mode .highlight-lines .highlight-line:before{content:" ";position:absolute;z-index:2;left:0;top:0;display:block;width:var(--code-ln-wrapper-width);height:100%}div[class*=language-].line-numbers-mode pre{margin-left:var(--code-ln-wrapper-width);padding-left:1rem;vertical-align:middle}div[class*=language-].line-numbers-mode .line-numbers{position:absolute;top:0;width:var(--code-ln-wrapper-width);text-align:center;color:var(--code-ln-color);padding-top:1.25rem;line-height:1.375;counter-reset:line-number}div[class*=language-].line-numbers-mode .line-numbers .line-number{position:relative;z-index:3;-webkit-user-select:none;-moz-user-select:none;user-select:none;height:1.375em}div[class*=language-].line-numbers-mode .line-numbers .line-number:before{counter-increment:line-number;content:counter(line-number);font-size:.85em}div[class*=language-].line-numbers-mode:after{content:"";position:absolute;top:0;left:0;width:var(--code-ln-wrapper-width);height:100%;border-radius:6px 0 0 6px;border-right:1px solid var(--code-hl-bg-color)}@media (max-width: 419px){.theme-default-content div[class*=language-]{margin:.85rem -1.5rem;border-radius:0}}.code-group__nav{margin-top:.85rem;margin-bottom:calc(-1.7rem - 6px);padding-bottom:calc(1.7rem - 6px);padding-left:10px;padding-top:10px;border-top-left-radius:6px;border-top-right-radius:6px;background-color:var(--code-bg-color)}.code-group__ul{margin:auto 0;padding-left:0;display:inline-flex;list-style:none}.code-group__nav-tab{border:0;padding:5px;cursor:pointer;background-color:transparent;font-size:.85em;line-height:1.4;color:#ffffffe6;font-weight:600}.code-group__nav-tab:focus{outline:none}.code-group__nav-tab:focus-visible{outline:1px solid rgba(255,255,255,.9)}.code-group__nav-tab-active{border-bottom:var(--c-brand) 1px solid}@media (max-width: 419px){.code-group__nav{margin-left:-1.5rem;margin-right:-1.5rem;border-radius:0}}.code-group-item{display:none}.code-group-item__active{display:block}.code-group-item>pre{background-color:orange}.custom-container{transition:color var(--t-color),border-color var(--t-color),background-color var(--t-color)}.custom-container .custom-container-title{font-weight:600}.custom-container .custom-container-title:not(:only-child){margin-bottom:-.4rem}.custom-container.tip,.custom-container.warning,.custom-container.danger{padding:.1rem 1.5rem;border-left-width:.5rem;border-left-style:solid;margin:1rem 0}.custom-container.tip{border-color:var(--c-tip);background-color:var(--c-tip-bg);color:var(--c-tip-text)}.custom-container.tip .custom-container-title{color:var(--c-tip-title)}.custom-container.tip a{color:var(--c-tip-text-accent)}.custom-container.tip code{background-color:var(--c-bg-dark)}.custom-container.warning{border-color:var(--c-warning);background-color:var(--c-warning-bg);color:var(--c-warning-text)}.custom-container.warning .custom-container-title{color:var(--c-warning-title)}.custom-container.warning a{color:var(--c-warning-text-accent)}.custom-container.warning blockquote{border-left-color:var(--c-warning-border-dark);color:var(--c-warning-text-quote)}.custom-container.warning code{color:var(--c-warning-text-light);background-color:var(--c-warning-bg-light)}.custom-container.warning details{background-color:var(--c-warning-details-bg)}.custom-container.warning details code{background-color:var(--c-warning-bg-lighter)}.custom-container.warning .external-link-icon{--external-link-icon-color: var(--c-warning-text-quote)}.custom-container.danger{border-color:var(--c-danger);background-color:var(--c-danger-bg);color:var(--c-danger-text)}.custom-container.danger .custom-container-title{color:var(--c-danger-title)}.custom-container.danger a{color:var(--c-danger-text-accent)}.custom-container.danger blockquote{border-left-color:var(--c-danger-border-dark);color:var(--c-danger-text-quote)}.custom-container.danger code{color:var(--c-danger-text-light);background-color:var(--c-danger-bg-light)}.custom-container.danger details{background-color:var(--c-danger-details-bg)}.custom-container.danger details code{background-color:var(--c-danger-bg-lighter)}.custom-container.danger .external-link-icon{--external-link-icon-color: var(--c-danger-text-quote)}.custom-container.details{display:block;position:relative;border-radius:2px;margin:1.6em 0;padding:1.6em;background-color:var(--c-details-bg)}.custom-container.details code{background-color:var(--c-bg-darker)}.custom-container.details h4{margin-top:0}.custom-container.details figure:last-child,.custom-container.details p:last-child{margin-bottom:0;padding-bottom:0}.custom-container.details summary{outline:none;cursor:pointer}.home{padding:var(--navbar-height) 2rem 0;max-width:var(--homepage-width);margin:0 auto;display:block}.home .hero{text-align:center}.home .hero img{max-width:100%;max-height:280px;display:block;margin:3rem auto 1.5rem}.home .hero h1{font-size:3rem}.home .hero h1,.home .hero .description,.home .hero .actions{margin:1.8rem auto}.home .hero .actions{display:flex;flex-wrap:wrap;gap:1rem;justify-content:center}.home .hero .description{max-width:35rem;font-size:1.6rem;line-height:1.3;color:var(--c-text-lightest)}.home .hero .action-button{display:inline-block;font-size:1.2rem;padding:.8rem 1.6rem;border-width:2px;border-style:solid;border-radius:4px;transition:background-color var(--t-color);box-sizing:border-box}.home .hero .action-button.primary{color:var(--c-bg);background-color:var(--c-brand);border-color:var(--c-brand)}.home .hero .action-button.primary:hover{background-color:var(--c-brand-light)}.home .hero .action-button.secondary{color:var(--c-brand);background-color:var(--c-bg);border-color:var(--c-brand)}.home .hero .action-button.secondary:hover{color:var(--c-bg);background-color:var(--c-brand-light)}.home .features{border-top:1px solid var(--c-border);transition:border-color var(--t-color);padding:1.2rem 0;margin-top:2.5rem;display:flex;flex-wrap:wrap;align-items:flex-start;align-content:stretch;justify-content:space-between}.home .feature{flex-grow:1;flex-basis:30%;max-width:30%}.home .feature h2{font-size:1.4rem;font-weight:500;border-bottom:none;padding-bottom:0;color:var(--c-text-light)}.home .feature p{color:var(--c-text-lighter)}.home .theme-default-content{padding:0;margin:0}.home .footer{padding:2.5rem;border-top:1px solid var(--c-border);text-align:center;color:var(--c-text-lighter);transition:border-color var(--t-color)}@media (max-width: 719px){.home .features{flex-direction:column}.home .feature{max-width:100%;padding:0 2.5rem}}@media (max-width: 419px){.home{padding-left:1.5rem;padding-right:1.5rem}.home .hero img{max-height:210px;margin:2rem auto 1.2rem}.home .hero h1{font-size:2rem}.home .hero h1,.home .hero .description,.home .hero .actions{margin:1.2rem auto}.home .hero .description{font-size:1.2rem}.home .hero .action-button{font-size:1rem;padding:.6rem 1.2rem}.home .feature h2{font-size:1.25rem}}.page{padding-top:var(--navbar-height);padding-left:var(--sidebar-width)}.navbar{position:fixed;z-index:20;top:0;left:0;right:0;height:var(--navbar-height);box-sizing:border-box;border-bottom:1px solid var(--c-border);background-color:var(--c-bg-navbar);transition:background-color var(--t-color),border-color var(--t-color)}.sidebar{font-size:16px;width:var(--sidebar-width);position:fixed;z-index:10;margin:0;top:var(--navbar-height);left:0;bottom:0;box-sizing:border-box;border-right:1px solid var(--c-border);overflow-y:auto;scrollbar-width:thin;scrollbar-color:var(--c-brand) var(--c-border);background-color:var(--c-bg-sidebar);transition:transform var(--t-transform),background-color var(--t-color),border-color var(--t-color)}.sidebar::-webkit-scrollbar{width:7px}.sidebar::-webkit-scrollbar-track{background-color:var(--c-border)}.sidebar::-webkit-scrollbar-thumb{background-color:var(--c-brand)}.sidebar-mask{position:fixed;z-index:9;top:0;left:0;width:100vw;height:100vh;display:none}.theme-container.sidebar-open .sidebar-mask{display:block}.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(1){transform:rotate(45deg) translate3d(5.5px,5.5px,0)}.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(2){transform:scale3d(0,1,1)}.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(3){transform:rotate(-45deg) translate3d(6px,-6px,0)}.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(1),.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(3){transform-origin:center}.theme-container.no-navbar .theme-default-content h1,.theme-container.no-navbar .theme-default-content h2,.theme-container.no-navbar .theme-default-content h3,.theme-container.no-navbar .theme-default-content h4,.theme-container.no-navbar .theme-default-content h5,.theme-container.no-navbar .theme-default-content h6{margin-top:1.5rem;padding-top:0}.theme-container.no-navbar .page{padding-top:0}.theme-container.no-navbar .sidebar{top:0}.theme-container.no-sidebar .sidebar{display:none}@media (max-width: 719px){.theme-container.no-sidebar .sidebar{display:block}}.theme-container.no-sidebar .page{padding-left:0}.theme-default-content a:hover{text-decoration:underline}.theme-default-content img{max-width:100%}.theme-default-content h1,.theme-default-content h2,.theme-default-content h3,.theme-default-content h4,.theme-default-content h5,.theme-default-content h6{margin-top:calc(.5rem - var(--navbar-height));padding-top:calc(1rem + var(--navbar-height));margin-bottom:0}.theme-default-content h1:first-child,.theme-default-content h2:first-child,.theme-default-content h3:first-child,.theme-default-content h4:first-child,.theme-default-content h5:first-child,.theme-default-content h6:first-child{margin-bottom:1rem}.theme-default-content h1:first-child+p,.theme-default-content h1:first-child+pre,.theme-default-content h1:first-child+.custom-container,.theme-default-content h2:first-child+p,.theme-default-content h2:first-child+pre,.theme-default-content h2:first-child+.custom-container,.theme-default-content h3:first-child+p,.theme-default-content h3:first-child+pre,.theme-default-content h3:first-child+.custom-container,.theme-default-content h4:first-child+p,.theme-default-content h4:first-child+pre,.theme-default-content h4:first-child+.custom-container,.theme-default-content h5:first-child+p,.theme-default-content h5:first-child+pre,.theme-default-content h5:first-child+.custom-container,.theme-default-content h6:first-child+p,.theme-default-content h6:first-child+pre,.theme-default-content h6:first-child+.custom-container{margin-top:2rem}@media (max-width: 959px){.sidebar{font-size:15px;width:var(--sidebar-width-mobile)}.page{padding-left:var(--sidebar-width-mobile)}}@media (max-width: 719px){.sidebar{top:0;padding-top:var(--navbar-height);transform:translate(-100%)}.page{padding-left:0}.theme-container.sidebar-open .sidebar{transform:translate(0)}.theme-container.no-navbar .sidebar{padding-top:0}}@media (max-width: 419px){h1{font-size:1.9rem}}.navbar{--navbar-line-height: calc( var(--navbar-height) - 2 * var(--navbar-padding-v) );padding:var(--navbar-padding-v) var(--navbar-padding-h);line-height:var(--navbar-line-height)}.navbar .logo{height:var(--navbar-line-height);margin-right:var(--navbar-padding-v);vertical-align:top}.navbar .site-name{font-size:1.3rem;font-weight:600;color:var(--c-text);position:relative}.navbar .navbar-items-wrapper{display:flex;position:absolute;box-sizing:border-box;top:var(--navbar-padding-v);right:var(--navbar-padding-h);height:var(--navbar-line-height);padding-left:var(--navbar-padding-h);white-space:nowrap;font-size:.9rem}.navbar .navbar-items-wrapper .search-box{flex:0 0 auto;vertical-align:top}@media screen and (max-width: 719px){.navbar{padding-left:4rem}.navbar .site-name{display:block;width:calc(100vw - 11rem);overflow:hidden;white-space:nowrap;text-overflow:ellipsis}.navbar .can-hide{display:none}}.navbar-items{display:inline-block}@media print{.navbar-items{display:none}}.navbar-items a{display:inline-block;line-height:1.4rem;color:inherit}.navbar-items a:hover,.navbar-items a.router-link-active{color:var(--c-text)}.navbar-items .navbar-item{position:relative;display:inline-block;margin-left:1.5rem;line-height:var(--navbar-line-height)}.navbar-items .navbar-item:first-child{margin-left:0}.navbar-items .navbar-item>a:hover,.navbar-items .navbar-item>a.router-link-active{margin-bottom:-2px;border-bottom:2px solid var(--c-text-accent)}@media (max-width: 719px){.navbar-items .navbar-item{margin-left:0}.navbar-items .navbar-item>a:hover,.navbar-items .navbar-item>a.router-link-active{margin-bottom:0;border-bottom:none}.navbar-items a:hover,.navbar-items a.router-link-active{color:var(--c-text-accent)}}.toggle-sidebar-button{position:absolute;top:.6rem;left:1rem;display:none;padding:.6rem;cursor:pointer}.toggle-sidebar-button .icon{display:flex;flex-direction:column;justify-content:center;align-items:center;width:1.25rem;height:1.25rem;cursor:inherit}.toggle-sidebar-button .icon span{display:inline-block;width:100%;height:2px;border-radius:2px;background-color:var(--c-text);transition:transform var(--t-transform)}.toggle-sidebar-button .icon span:nth-child(2){margin:6px 0}@media screen and (max-width: 719px){.toggle-sidebar-button{display:block}}.toggle-color-mode-button{display:flex;margin:auto;margin-left:1rem;border:0;background:none;color:var(--c-text);opacity:.8;cursor:pointer}@media print{.toggle-color-mode-button{display:none}}.toggle-color-mode-button:hover{opacity:1}.toggle-color-mode-button .icon{width:1.25rem;height:1.25rem}.DocSearch{transition:background-color var(--t-color)}.navbar-dropdown-wrapper{cursor:pointer}.navbar-dropdown-wrapper .navbar-dropdown-title,.navbar-dropdown-wrapper .navbar-dropdown-title-mobile{display:block;font-size:.9rem;font-family:inherit;cursor:inherit;padding:inherit;line-height:1.4rem;background:transparent;border:none;font-weight:500;color:var(--c-text)}.navbar-dropdown-wrapper .navbar-dropdown-title:hover,.navbar-dropdown-wrapper .navbar-dropdown-title-mobile:hover{border-color:transparent}.navbar-dropdown-wrapper .navbar-dropdown-title .arrow,.navbar-dropdown-wrapper .navbar-dropdown-title-mobile .arrow{vertical-align:middle;margin-top:-1px;margin-left:.4rem}.navbar-dropdown-wrapper .navbar-dropdown-title-mobile{display:none;font-weight:600;font-size:inherit}.navbar-dropdown-wrapper .navbar-dropdown-title-mobile:hover{color:var(--c-text-accent)}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item{color:inherit;line-height:1.7rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle{margin:.45rem 0 0;border-top:1px solid var(--c-border);padding:1rem 0 .45rem;font-size:.9rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle>span{padding:0 1.5rem 0 1.25rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle>a{font-weight:inherit}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle>a.router-link-active:after{display:none}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subitem-wrapper{padding:0;list-style:none}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subitem-wrapper .navbar-dropdown-subitem{font-size:.9em}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a{display:block;line-height:1.7rem;position:relative;border-bottom:none;font-weight:400;margin-bottom:0;padding:0 1.5rem 0 1.25rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a:hover,.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a.router-link-active{color:var(--c-text-accent)}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a.router-link-active:after{content:"";width:0;height:0;border-left:5px solid var(--c-text-accent);border-top:3px solid transparent;border-bottom:3px solid transparent;position:absolute;top:calc(50% - 2px);left:9px}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item:first-child .navbar-dropdown-subtitle{margin-top:0;padding-top:0;border-top:0}.navbar-dropdown-wrapper.mobile.open .navbar-dropdown-title,.navbar-dropdown-wrapper.mobile.open .navbar-dropdown-title-mobile{margin-bottom:.5rem}.navbar-dropdown-wrapper.mobile .navbar-dropdown-title,.navbar-dropdown-wrapper.mobile .navbar-dropdown-title-mobile{display:none}.navbar-dropdown-wrapper.mobile .navbar-dropdown-title-mobile{display:block}.navbar-dropdown-wrapper.mobile .navbar-dropdown{transition:height .1s ease-out;overflow:hidden}.navbar-dropdown-wrapper.mobile .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle{border-top:0;margin-top:0;padding-top:0;padding-bottom:0}.navbar-dropdown-wrapper.mobile .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle,.navbar-dropdown-wrapper.mobile .navbar-dropdown .navbar-dropdown-item>a{font-size:15px;line-height:2rem}.navbar-dropdown-wrapper.mobile .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subitem{font-size:14px;padding-left:1rem}.navbar-dropdown-wrapper:not(.mobile){height:1.8rem}.navbar-dropdown-wrapper:not(.mobile):hover .navbar-dropdown,.navbar-dropdown-wrapper:not(.mobile).open .navbar-dropdown{display:block!important}.navbar-dropdown-wrapper:not(.mobile).open:blur{display:none}.navbar-dropdown-wrapper:not(.mobile) .navbar-dropdown{display:none;height:auto!important;box-sizing:border-box;max-height:calc(100vh - 2.7rem);overflow-y:auto;position:absolute;top:100%;right:0;background-color:var(--c-bg-navbar);padding:.6rem 0;border:1px solid var(--c-border);border-bottom-color:var(--c-border-dark);text-align:left;border-radius:.25rem;white-space:nowrap;margin:0}.page{padding-bottom:2rem;display:block}.page .theme-default-content{max-width:var(--content-width);margin:0 auto;padding:2rem 2.5rem;padding-top:0}@media (max-width: 959px){.page .theme-default-content{padding:2rem}}@media (max-width: 419px){.page .theme-default-content{padding:1.5rem}}.page-meta{max-width:var(--content-width);margin:0 auto;padding:1rem 2.5rem;overflow:auto}@media (max-width: 959px){.page-meta{padding:2rem}}@media (max-width: 419px){.page-meta{padding:1.5rem}}.page-meta .meta-item{cursor:default;margin-top:.8rem}.page-meta .meta-item .meta-item-label{font-weight:500;color:var(--c-text-lighter)}.page-meta .meta-item .meta-item-info{font-weight:400;color:var(--c-text-quote)}.page-meta .edit-link{display:inline-block;margin-right:.25rem}@media print{.page-meta .edit-link{display:none}}.page-meta .last-updated{float:right}@media (max-width: 719px){.page-meta .last-updated{font-size:.8em;float:none}.page-meta .contributors{font-size:.8em}}.page-nav{max-width:var(--content-width);margin:0 auto;padding:1rem 2.5rem 2rem;padding-bottom:0}@media (max-width: 959px){.page-nav{padding:2rem}}@media (max-width: 419px){.page-nav{padding:1.5rem}}.page-nav .inner{min-height:2rem;margin-top:0;border-top:1px solid var(--c-border);transition:border-color var(--t-color);padding-top:1rem;overflow:auto}.page-nav .prev a:before{content:"←"}.page-nav .next{float:right}.page-nav .next a:after{content:"→"}.sidebar ul{padding:0;margin:0;list-style-type:none}.sidebar a{display:inline-block}.sidebar .navbar-items{display:none;border-bottom:1px solid var(--c-border);transition:border-color var(--t-color);padding:.5rem 0 .75rem}.sidebar .navbar-items a{font-weight:600}.sidebar .navbar-items .navbar-item{display:block;line-height:1.25rem;font-size:1.1em;padding:.5rem 0 .5rem 1.5rem}.sidebar .sidebar-items{padding:1.5rem 0}@media (max-width: 719px){.sidebar .navbar-items{display:block}.sidebar .navbar-items .navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a.router-link-active:after{top:calc(1rem - 2px)}.sidebar .sidebar-items{padding:1rem 0}}.sidebar-item{cursor:default;border-left:.25rem solid transparent;color:var(--c-text)}.sidebar-item:focus-visible{outline-width:1px;outline-offset:-1px}.sidebar-item.active:not(p.sidebar-heading){font-weight:600;color:var(--c-text-accent);border-left-color:var(--c-text-accent)}.sidebar-item.sidebar-heading{transition:color .15s ease;font-size:1.1em;font-weight:700;padding:.35rem 1.5rem .35rem 1.25rem;width:100%;box-sizing:border-box;margin:0}.sidebar-item.sidebar-heading+.sidebar-item-children{transition:height .1s ease-out;overflow:hidden;margin-bottom:.75rem}.sidebar-item.collapsible{cursor:pointer}.sidebar-item.collapsible .arrow{position:relative;top:-.12em;left:.5em}.sidebar-item:not(.sidebar-heading){font-size:1em;font-weight:400;display:inline-block;margin:0;padding:.35rem 1rem .35rem 2rem;line-height:1.4;width:100%;box-sizing:border-box}.sidebar-item:not(.sidebar-heading)+.sidebar-item-children{padding-left:1rem;font-size:.95em}.sidebar-item-children .sidebar-item-children .sidebar-item:not(.sidebar-heading){padding:.25rem 1rem .25rem 1.75rem}.sidebar-item-children .sidebar-item-children .sidebar-item:not(.sidebar-heading).active{font-weight:500;border-left-color:transparent}a.sidebar-heading+.sidebar-item-children .sidebar-item:not(.sidebar-heading).active{border-left-color:transparent}a.sidebar-item{cursor:pointer}a.sidebar-item:hover{color:var(--c-text-accent)}.table-of-contents .badge{vertical-align:middle}.dropdown-enter-from,.dropdown-leave-to{height:0!important}.fade-slide-y-enter-active{transition:all .2s ease}.fade-slide-y-leave-active{transition:all .2s cubic-bezier(1,.5,.8,1)}.fade-slide-y-enter-from,.fade-slide-y-leave-to{transform:translateY(10px);opacity:0}:root{--c-brand: #db502a;--c-brand-light: #db502a}html.dark{--c-brand: #db502a;--c-brand-light: #db502a}:root{--search-bg-color: #ffffff;--search-accent-color: #3eaf7c;--search-text-color: #2c3e50;--search-border-color: #eaecef;--search-item-text-color: #5d81a5;--search-item-focus-bg-color: #f3f4f5;--search-input-width: 8rem;--search-result-width: 20rem}.search-box{display:inline-block;position:relative;margin-left:1rem}@media print{.search-box{display:none}}.search-box input{-webkit-appearance:none;-moz-appearance:none;appearance:none;cursor:text;width:var(--search-input-width);height:2rem;color:var(--search-text-color);display:inline-block;border:1px solid var(--search-border-color);border-radius:2rem;font-size:.9rem;line-height:2rem;padding:0 .5rem 0 2rem;outline:none;transition:all ease .3s;background:var(--search-bg-color) url("data:image/svg+xml,%3c?xml%20version='1.0'%20encoding='UTF-8'?%3e%3csvg%20xmlns='http://www.w3.org/2000/svg'%20width='12'%20height='13'%3e%3cg%20stroke-width='2'%20stroke='%23aaa'%20fill='none'%3e%3cpath%20d='M11.29%2011.71l-4-4'/%3e%3ccircle%20cx='5'%20cy='5'%20r='4'/%3e%3c/g%3e%3c/svg%3e") .6rem .5rem no-repeat;background-size:1rem}.search-box input:focus{cursor:auto;border-color:var(--search-accent-color)}.search-box .suggestions{background:var(--search-bg-color);width:var(--search-result-width);position:absolute;top:2rem;right:0;border:1px solid var(--search-border-color);border-radius:6px;padding:.4rem;list-style-type:none}.search-box .suggestion{line-height:1.4;padding:.4rem .6rem;border-radius:4px;cursor:pointer}.search-box .suggestion.focus{background-color:var(--search-item-focus-bg-color)}.search-box .suggestion.focus a{color:var(--search-accent-color)}.search-box .suggestion a{white-space:normal;color:var(--search-item-text-color)}.search-box .suggestion .page-title{font-weight:600}.search-box .suggestion .page-header{font-size:.9em;margin-left:.25em}@media (max-width: 719px){.search-box input{cursor:pointer;width:0;border-color:transparent;position:relative}.search-box input:focus{cursor:text;left:0;width:10rem}}@media (max-width: 419px){.search-box input:focus{width:8rem}.search-box .suggestions{width:calc(100vw - 4rem);right:-.5rem}} diff --git a/assets/your-first-imposter.html-C8xizH02.js b/assets/your-first-imposter.html-C8xizH02.js new file mode 100644 index 0000000..b53c97b --- /dev/null +++ b/assets/your-first-imposter.html-C8xizH02.js @@ -0,0 +1,16 @@ +import{_ as s,o as n,c as t,e}from"./app-GKjJbFgT.js";const o={},a=e(`Your first imposter
At least one imposter must be configured in order to use Killgrave.
Every file with any of the valid extensions (.imp.json, .imp.yml or .imp.yaml), present in the "imposters" folder (default "./imposters") will be interpreted as an imposters file.
We use a rule-based system to match requests to imposters. Therefore, you have to organize your imposters from most restrictive to least.
Here's an example of the contents of an imposters file with a single imposter:
[
+ {
+ "request": {
+ "method": "GET",
+ "endpoint": "/gophers/01D8EMQ185CA8PRGE20DKZTGSR"
+ },
+ "response": {
+ "status": 200,
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": "{\\"data\\":{\\"type\\":\\"gophers\\",\\"id\\":\\"01D8EMQ185CA8PRGE20DKZTGSR\\",\\"attributes\\":{\\"name\\":\\"Zebediah\\",\\"color\\":\\"Purples\\",\\"age\\":55}}}"
+ }
+ }
+]
+This a very simple example. Killgrave has more possibilities for configuring imposters.
You can take a look at some of them in the "How to...?" section below.
`,9),p=[a];function i(r,u){return n(),t("div",null,p)}const c=s(o,[["render",i],["__file","your-first-imposter.html.vue"]]);export{c as default}; diff --git a/assets/your-first-imposter.html-t5dvpvCj.js b/assets/your-first-imposter.html-t5dvpvCj.js new file mode 100644 index 0000000..2912c24 --- /dev/null +++ b/assets/your-first-imposter.html-t5dvpvCj.js @@ -0,0 +1 @@ +const e=JSON.parse('{"key":"v-56beebfd","path":"/guide/your-first-imposter.html","title":"Your first imposter","lang":"en-US","frontmatter":{"prev":"./getting-started","next":"./advanced"},"headers":[],"git":{"updatedTime":1700862554000,"contributors":[{"name":"Joan López de la Franca Beltran","email":"joanjan14@gmail.com","commits":1}]},"filePathRelative":"guide/your-first-imposter.md"}');export{e as data}; diff --git a/cli/index.html b/cli/index.html new file mode 100644 index 0000000..d520866 --- /dev/null +++ b/cli/index.html @@ -0,0 +1,58 @@ + + + + + + + + +⚠️Remember that you will need to escape any special char, in the properties that admit text.
KillgraveCommand-line interface (CLI)
Killgrave
Killgrave is basically a command-line interface (CLI) that can be used with no explicit configuration, but a set of imposters. Look at the config reference or guide for further details.
However, you can tune up some of their settings like the host and port where the mock server is listening to, among others, by providing some configuration settings.
To provide those settings, you can either use the available CLI flags or use the -config flag to provide the path to a settings file. In such case, you can either use a JSON or YAML configuration file.
Available flags
See below the list of available flags:
$ killgrave -h
+
+ -config string
+ path to the configuration file
+ -debugger
+ run your server with the debugger
+ -debugger-addr string
+ debugger address (default "localhost:3030")
+ -host string
+ run your server on a different host (default "localhost")
+ -imposters string
+ directory where imposters are read from (default "imposters")
+ -port int
+ run your server on a different port (default 3000)
+ -proxy-mode string
+ proxy mode (choose between 'all', 'missing' or 'none') (default "none")
+ -proxy-url string
+ proxy url, use it in combination with proxy-mode
+ -secure
+ run your server using TLS (https)
+ -version
+ show the version of the application
+ -watcher
+ enable the file watcher, which reloads the server on every file change
+Config Reference
Killgrave
Killgrave can be used without explicitly providing any configuration. However, you can tune up some of their settings like the host and port where the mock server is listening to, among others, by providing some configuration settings.
To provide those settings, you can either use the available CLI flags or use the -config flag to provide the path to a settings file. In such case, you can either use JSON or YAML.
Basic
Minimal configuration attributes needed to get your mock up and running.
host
- Type:
string - Default:
localhost
Specify the host for the Killgrave server. If you are using Docker, you must override the default value. Otherwise, the server will be reachable only from the container itself, so probably it won't work as you expect.
{
+ "host": "localhost"
+}
+host: "localhost"
+port
- Type:
number - Default:
3000
Specify the port for the Killgrave server. If you are using Docker, you need to forward it.
{
+ "port": 3000
+}
+port: 3000
+imposters_path
- Type:
string - Default:
imposters
Specify the directory the imposter files (either .imp.json, .imp.yml or .imp.yaml) will be loaded from. On a regular set up, this directory will contain multiple of those imposter files and the directories with schemas and responses.
{
+ "imposters_path": "imposters"
+}
+imposters_path: imposters
+Proxy
Set up a proxy to redirect the incoming requests as you want.
mode
- Type:
string - Default:
none
Specify the proxy mode for the Killgrave server. The default value is none which means no proxy. Use missing to redirect only those incoming requests that aren't defined within the imposters. Use all to redirect all incoming requests.
{
+ "proxy": {
+ "mode": "missing"
+ }
+}
+proxy:
+ mode: missing
+url
- Type:
string - Default: -
Specify the url for the Killgrave's proxy. The incoming requests will be redirected to this url based on the proxy mode.
{
+ "proxy": {
+ "url": "https://example.com"
+ }
+}
+proxy:
+ url: https://example.com
+CORS
Set up the cross-origin resource sharing (CORS) mechanism for the Killgrave server. Especially useful when mocking servers that are consumed by frontend applications.
methods
- Type:
string array - Default:
["GET", "HEAD", "POST", "PUT", "OPTIONS", "DELETE", "PATCH", "TRACE", "CONNECT"]
Represents the Access-Control-Request-Method header.
{
+ "cors": {
+ "methods": ["GET"]
+ }
+}
+cors:
+ methods: ["GET"]
+headers
- Type:
string array - Default:
["X-Requested-With", "Content-Type", "Authorization"]
Represents the Access-Control-Request-Headers header.
{
+ "cors": {
+ "headers": ["Content-Type"]
+ }
+}
+cors:
+ headers: ["Content-Type"]
+exposed_headers
- Type:
string array - Default:
["Cache-Control", "Content-Language", "Content-Type", "Expires", "Last-Modified", "Pragma"]
Represents the Access-Control-Expose-Headers header.
{
+ "cors": {
+ "exposed_headers": ["Cache-Control"]
+ }
+}
+cors:
+ exposed_headers: ["Cache-Control"]
+origins
- Type:
string array - Default:
[]
Represents the Access-Control-Allow-Origin header.
{
+ "cors": {
+ "origins": ["*"]
+ }
+}
+cors:
+ origins: ["*"]
+allow_credentials
- Type:
boolean - Default:
false
Enables or disables the Access-Control-Allow-Credentials header.
{
+ "cors": {
+ "allow_credentials": true
+ }
+}
+cors:
+ allow_credentials: true
+Security
Sometimes you may want to simulate a production-like behavior with your mock servers, for instance to verify that your frontend application manages correctly HTTPS/TLS connections.
secure
- Type:
boolean - Default:
false
Expose the mock server through HTTP over TLS(SSL).
{
+ "secure": true
+}
+secure: true
+Hot reloads
When building the imposters to mock your server, you way want to reduce the feedback loop on configuration changes.
watcher
- Type:
boolean - Default:
false
Enable the file watcher to hot reload the mock server on every imposters change.
{
+ "watcher": true
+}
+watcher: true
+Full example
See below a full example of the configuration file:
{
+ "port": 3000,
+ "host": "localhost",
+ "imposters_path": "imposters",
+ "proxy": {
+ "url": "https://example.com",
+ "mode": "missing"
+ },
+ "cors": {
+ "methods": [
+ "GET"
+ ],
+ "headers": [
+ "Content-Type"
+ ],
+ "exposed_headers": [
+ "Cache-Control"
+ ],
+ "origins": [
+ "*"
+ ],
+ "allow_credentials": true
+ },
+ "secure": true,
+ "watcher": true
+}
+port: 3000
+host: "localhost"
+imposters_path: "imposters"
+proxy:
+ url: https://example.com
+ mode: missing
+cors:
+ methods: ["GET"]
+ headers: ["Content-Type"]
+ exposed_headers: ["Cache-Control"]
+ origins: ["*"]
+ allow_credentials: true
+secure: true
+watcher: true
+Imposters
Imposters are the first-class citizens in Killgrave, they define how the mock server will respond to the incoming requests. You can use either JSON or YAML to define them.
Request
The request configuration is used to evaluate whether an incoming request matches the imposter or not. If there's a match, the mock server will respond with the imposter's response.
method
- Type:
string - Default: -
Specify the expected HTTP method.
{
+ "request": {
+ "method": "POST"
+ }
+}
+request:
+ method: "POST"
+endpoint
- Type:
string - Default: -
Specify the expected URL endpoint (path). You can define URL parameters and use regular expressions. Look at Gorilla Mux examples to see how regular expressions work.
{
+ "request": {
+ "endpoint": "/gophers"
+ }
+}
+request:
+ endpoint: /gophers
+schemaFile
- Type:
string - Default: -
Specify the path to the file that contains the expected JSON schema.
{
+ "request": {
+ "schemaFile": "schemas/create_gopher_request.json"
+ }
+}
+request:
+ schemaFile: "schemas/create_gopher_request.json"
+params
- Type:
string map - Default: -
Specify the expected URL params. You can use regular expressions. Look at Gorilla Mux examples to see how regular expressions work.
{
+ "request": {
+ "params": {
+ "id": "01EKPT"
+ }
+ }
+}
+request:
+ params:
+ id: "01EKPT"
+headers
- Type:
string map - Default: -
Specify the expected HTTP headers.
{
+ "request": {
+ "headers": {
+ "Content-Type": "application/json",
+ "Return-Error": "error"
+ }
+ }
+}
+request:
+ headers:
+ Content-Type: "application/json"
+ Return-Error: "error"
+Response
The response configuration is used to build the response in case of match with the incoming request.
status
- Type:
number - Default:
200
Specify the response's HTTP status code.
{
+ "response": {
+ "status": 401
+ }
+}
+response:
+ status: 401
+body
- Type:
string - Default: -
Specify the raw contents (as string) to be returned as the response body. You could use a stringified JSON, for instance.
Although, in such cases where the desired response body is a complex payload (e.g. a JSON object), we recommend to use a separate file in combination with the bodyFile request attribute.
{
+ "response": {
+ "body": "Simple response body"
+ }
+}
+response:
+ body: "Simple response body"
+bodyFile
- Type:
string - Default: -
Specify the path to the file that contains the response body's contents.
{
+ "response": {
+ "bodyFile": "/path/to/file"
+ }
+}
+response:
+ bodyFile: "/path/to/file"
+headers
- Type:
string map - Default: -
Specify the response's HTTP headers.
{
+ "response": {
+ "headers": {
+ "Content-Type": "application/json",
+ "Return-Error": "error"
+ }
+ }
+}
+response:
+ headers:
+ Content-Type: "application/json"
+ Return-Error: "error"
+delay
- Type:
string - Default: -
Specify the response delay. It is really helpful to reproduce real-world examples and/or to simulate situations with peaks of load where the responses are considerably slow.
You can use either a fixed time (single value) or an interval (two values joined by :).
Look at Go time.ParseDuration examples to see the accepted format to specify the time durations of the response delay.
{
+ "response": {
+ "delay": "2s:5s"
+ }
+}
+response:
+ delay: "2s:5s"
+Full examples
See below some full examples:
Request
{
+ "request": {
+ "method": "POST",
+ "endpoint": "/gophers",
+ "schemaFile": "schemas/create_gopher_request.json",
+ "params": {
+ "id": "01EKPT"
+ },
+ "headers": {
+ "Content-Type": "application/json",
+ "Return-Error": "error"
+ }
+ }
+}
+request:
+ method: "POST"
+ endpoint: "/gophers"
+ schemaFile": "schemas/create_gopher_request.json"
+ params":
+ id: "01EKPT"
+ headers:
+ Content-Type: "application/json"
+ Return-Error: "error"
+Response
{
+ "response": {
+ "status": 401,
+ "body": "Simple response body",
+ "bodyFile": "/path/to/file",
+ "headers": {
+ "Content-Type": "application/json",
+ "Return-Error": "error"
+ },
+ "delay": "2s:5s"
+ }
+}
+response:
+ status: 401
+ body: "Simple response body"
+ bodyFile: "/path/to/file"
+ headers:
+ Content-Type: "application/json"
+ Return-Error: "error"
+ delay: "2s:5s"
+Note from the examples above that you should only provide one of body or bodyFile, but not both. Here both are defined just for the sake of showing a full example.
KillgraveAdvanced features
Killgrave has some advanced features:
CORS
If you want to use Killgrave from a frontend application, you should consider configuring cross-origin resource sharing (CORS).
In the CORS section of the file you can find the following options:
- methods:
Access-Control-Request-Method - headers:
Access-Control-Request-Headers - exposed_headers:
Access-Control-Expose-Headers - origins:
Access-Control-Allow-Origin - allow_credentials:
Access-Control-Allow-Credentials
You can find further details here.
Proxy
You can use Killgrave in proxy mode using the flags proxy-mode and proxy-url or their equivalent fields in the configuration file. The following three proxy modes are available:
none: (Default) Killgrave won't behave as a proxy and will only use the configured imposters.missing: Killgrave will try to match the request with a configured imposter. Otherwise, it will forward the request to the configured proxy.all: Killgrave will forward all the incoming requests to the configured proxy.
The proxy-url must be the root path of the proxy server. For instance, if we have an API running on http://example.com/things, the configured proxy-url should be http://example.com.
Secure (HTTP over TLS)
Killgrave has a secure mode that lets you expose your mock servers over secure connections by using HTTP over TLS/SSL (HTTPS).
You can use the secure setting to enable the secure mode. Disabled by default.
If enabled, the mock server will use TLS options with a dummy certificate, to make it work with the HTTPS protocol.
Watcher
Killgrave has a file watcher that lets you hot reload your mock servers on every imposters change.
You can use the watcher setting to enable the secure mode. Disabled by default.
If enabled, the file watcher will be watching changes on the imposters directory so the mock server will be restarted on every imposters change.
Debugger
Killgrave has an interactive mode that lets you debug the behavior of your mock server.
You can use the debugger settings to enable the interactive mode. Disabled by default.
You can find further details here.
KillgraveConcepts
Imposters
Imposters are the most important concept in the Killgrave's world.
They conform the rules that determine how the mock server should respond to a request.
You can identify a Killgrave imposter file by its extension: .imp.json, .imp.yml or .imp.yaml.
You can learn more about how to configure imposters in the Imposter Configuration Section.
Imposters Structure
The imposter object can be divided in two parts:
Request
This part defines how Killgrave should determine whether an incoming request matches the imposter or not.
The request object has the following properties:
method(mandatory): The HTTP method of the incoming request.endpoint(mandatory): Path of the endpoint relative to the base. Supports regular expressions.schemaFile: A JSON schema to validate the incoming request against.params: Restrict incoming requests by query parameters. Supports regular expressions.headers: Restrict incoming requests by HTTP header.
Response
This part defines how Killgrave should, in case of match, respond to the incoming request.
The response object has the following properties:
status(mandatory): Integer defining the HTTP status code to return.bodyorbodyFile: The response body. Either a literal string (body) or a path to a file (bodyFile).bodyFileis especially useful in the case of large outputs. This property is optional: if not response body should be returned it should be removed or left empty.headers: HTTP headers to return in the response.delay: Time the server waits before responding. This can help simulate network issues, or high server load. Uses the Gotime.ParseDurationformat. Also, you can specify minimum and maximum delays separated by:. The response delay will be chosen randomly between these values. Default value is"0s"(no delay).
KillgraveGetting started
To start Killgrave, you can simply do it by running:
$ killgrave
+While you are welcome to provide your own configuration, Killgrave will default to the following configuration:
- imposters path:
imposters- host:
localhost- port:
3000- CORS:
[]- proxy:
none- watcher:
false- debugger:
- enabled:
false- address:
localhost:3030
Command-line interface
Killgrave is almost fully configurable through the command line, except for CORS, which can only be configured using the config file.
You can find the list with all the available flags at CLI section or by running:
$ killgrave -h
+Configuration file
In case you are looking for a predictable and reproducible configuration, you can use the -config command-line flag to specify the location of a configuration file, which can be written either in JSON or YAML.
You can find the list with all the available settings at Config Reference section.
As you can see, you can configure all the options in a very easy way.
Historically, the options
imposters_path,portandhostwere mandatory when using a configuration file. However, since the last version (v0.4.1), they are no longer needed, so you can simply override those options if you actually want to. Furthermore, in previous versions (prior tov0.4.1), theimposters_pathoption was used to refer to the path to the working directory where Killgrave was executed from, but since the last version (v0.4.1) this is relative to the location of the config file.
KillgraveUse delayed responses
If you want to simulate a problem with the network, or create a more realistic response, you can use the delay property.
The delay property can take duration in the Go ParseDuration format. The server response will be delayed by the specified duration.
Alternatively, the delay property can take a range of two durations, separated by :. In this case, the server will respond with a random delay within this range.
With the example below, the response would be delayed between 1 and 5 seconds:
[
+ {
+ "request": {
+ "method": "POST",
+ "endpoint": "/gophers",
+ "schemaFile": "schemas/create_gopher_request.json",
+ "headers": {
+ "Content-Type": "application/json"
+ }
+ },
+ "response": {
+ "status": 201,
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "delay": "1s:5s"
+ }
+ }
+]
+Use dynamic responses
Killgrave allows dynamic responses. Using this feature, Killgrave can return different responses on the same endpoint.
To do this, all imposters need to be sorted from most restrictive to least. Killgrave tries to match the request with each of the imposters in sequence, stopping at the first imposter that matches the request.
In the following example, there are defined multiple imposters for the POST /gophers endpoint:
[
+ {
+ "request": {
+ "method": "POST",
+ "endpoint": "/gophers",
+ "schemaFile": "schemas/create_gopher_request.json",
+ "headers": {
+ "Content-Type": "application/json"
+ }
+ },
+ "response": {
+ "status": 201,
+ "headers": {
+ "Content-Type": "application/json"
+ }
+ }
+ },
+ {
+ "request": {
+ "method": "POST",
+ "endpoint": "/gophers"
+ },
+ "response": {
+ "status": 400,
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": "{\"errors\":\"bad request\"}"
+ }
+ }
+]
+Now,
- Let's say an incoming request does not match the JSON schema specified in the first imposter's
schemaFile. - Therefore, Killgrave skips this imposter and tries to match the request against the next configured imposter.
- The next configured imposter is much less restrictive, so the request matches and the associated response is returned.
KillgraveUse JSON Schema
Sometimes you may need to validate requests more thoroughly. In such case, you can create an imposter that only matches with a valid json schema.
To do that you will need to define our json schema first:
e.g. imposters/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"
+ ]
+}
+With this json schema, we expect a request like this:
{
+ "data": {
+ "type": "gophers",
+ "attributes": {
+ "name": "Zebediah",
+ "color": "Purples",
+ "age": 55
+ }
+ }
+}
+Then the imposter could be configured as follows:
[
+ {
+ "request": {
+ "method": "POST",
+ "endpoint": "/gophers",
+ "schemaFile": "schemas/create_gopher_request.json",
+ "headers": {
+ "Content-Type": "application/json"
+ }
+ },
+ "response": {
+ "status": 201,
+ "headers": {
+ "Content-Type": "application/json"
+ }
+ }
+ }
+]
+The path where the schema is located is relative to where the imposters are.
KillgraveUse regular expressions (regex)
Regex in the endpoint
Killgrave uses the gorilla/mux regular expression format for endpoint matching.
In the next example, we have configured an endpoint to match with any kind of ULID ID:
[
+ {
+ "request": {
+ "method": "GET",
+ "endpoint": "/gophers/{_id:[\\w]{26}}"
+ },
+ "response": {
+ "status": 200,
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": "{\"data\":{\"type\":\"gophers\",\"id\":\"01D8EMQ185CA8PRGE20DKZTGSR\",\"attributes\":{\"name\":\"Zebediah\",\"color\":\"Purples\",\"age\":55}}}"
+ }
+ }
+]
+Regex in the query parameters
Killgrave uses the gorilla/mux regular expression format for query parameter matching.
In this example, we have configured an imposter that only matches if we receive an apiKey as query parameter:
[
+ {
+ "request": {
+ "method": "GET",
+ "endpoint": "/gophers/{_id:[\\w]{26}}",
+ "params": {
+ "apiKey": "{_apiKey:[\\w]+}"
+ }
+ },
+ "response": {
+ "status": 200,
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": "{\"data\":{\"type\":\"gophers\",\"id\":\"01D8EMQ185CA8PRGE20DKZTGSR\",\"attributes\":{\"name\":\"Zebediah\",\"color\":\"Purples\",\"age\":55}}}"
+ }
+ }
+]
+Regex in the headers:
In this case we will not need the gorilla mux nomenclature to write our regex.
In the next example, we have configured an imposter that uses regex to match an Authorization header.
[
+ {
+ "request": {
+ "method": "GET",
+ "endpoint": "/gophers/{id:[\\w]{26}}",
+ "headers": {
+ "Authorization": "\\w+"
+ }
+ },
+ "response": {
+ "status": 200,
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": "{\"data\":{\"type\":\"gophers\",\"id\":\"01D8EMQ185CA8PRGE20DKZTGSR\",\"attributes\":{\"name\":\"Zebediah\",\"color\":\"Purples\",\"age\":55}}}"
+ }
+ }
+]
+Killgrave
Killgrave is a tool that provides a simple way to create a powerful simulator for HTTP-based APIs.
The Killgrave's philosophy is to provide an easy way to configure your mock server, ensuring that you don't need to learn another tooling language. For that reason we use JSON and YAML to generate all necessary configurations.
Some Killgrave features are:
- An easy way to create imposters files, either using JSON or YAML.
- The possibility to validate requests against JSON schemas.
- Use of regular expressions to allow different parameters in headers and urls.
- Custom and dynamic response bodies, of all content types (application/json, text/html...).
- Custom response headers and cross-origin resource sharing (CORS).
- Simulate network issues and server high loads with configurable, dynamic responses delay.
- Use of configurable proxy server to call to the original server.
- Use either command-line interface flags or a configuration file (JSON/YAML).
- Hot configuration reloads based on a configurable file watcher.
- Expose the mocker server through HTTP over TLS (SSL).
- Use of an interactive mode to debug your mock server with a web app.
KillgraveInstallation
⚠️ Even though Killgrave is a very robust tool and is being used by some companies in production environments, it's still in initial development. Therefore, 'minor' version numbers are used to signify breaking changes and 'patch' version numbers are used for non-breaking changes or bugfixing. As soon as v1.0.0 is released, Killgrave will start to use SemVer as usual.
You can install Killgrave in different ways, but all of them are very simple:
Go Toolchain
One of them is of course using go install, Killgrave is a Go project and therefore can be compiled using the go toolchain:
$ go install github.com/friendsofgo/killgrave/cmd/killgrave@{version}
+Note that version must be replaced by the version that you want to install. If left unspecified, the main branch will be installed.
Homebrew
If you are a macOS user, you can install Killgrave using Homebrew:
$ brew install friendsofgo/tap/killgrave
+⚠️ If you are installing via Homebrew, you always get the latest Killgrave version, we hope to fix this soon!
Docker
Killgrave is also available through Docker.
$ docker run -it --rm -p 3000:3000 -v $PWD/:/home -w /home friendsofgo/killgrave -host 0.0.0.0
+-p 3000:3000is used to forward the local port3000(Killgrave's default port) to container's port3000, otherwise Killgrave won't be reachable from the host.-host 0.0.0.0is used to change the Killgrave's default host (localhost) to allow Killgrave to listen to and respond to incoming requests from outside the container, otherwise Killgrave won't be reachable from the host.
Other
Windows and Linux users can download binaries from the GitHub Releases page.
KillgraveYour first imposter
At least one imposter must be configured in order to use Killgrave.
Every file with any of the valid extensions (.imp.json, .imp.yml or .imp.yaml), present in the "imposters" folder (default "./imposters") will be interpreted as an imposters file.
We use a rule-based system to match requests to imposters. Therefore, you have to organize your imposters from most restrictive to least.
Here's an example of the contents of an imposters file with a single imposter:
[
+ {
+ "request": {
+ "method": "GET",
+ "endpoint": "/gophers/01D8EMQ185CA8PRGE20DKZTGSR"
+ },
+ "response": {
+ "status": 200,
+ "headers": {
+ "Content-Type": "application/json"
+ },
+ "body": "{\"data\":{\"type\":\"gophers\",\"id\":\"01D8EMQ185CA8PRGE20DKZTGSR\",\"attributes\":{\"name\":\"Zebediah\",\"color\":\"Purples\",\"age\":55}}}"
+ }
+ }
+]
+This a very simple example. Killgrave has more possibilities for configuring imposters.
You can take a look at some of them in the "How to...?" section below.
⚠️Remember that you will need to escape any special char, in the properties that admit text.