Crate funes[−][src]

Expand description

Lo recuerdo (yo no tengo derecho a pronunciar ese verbo sagrado, sólo un hombre en la tierra tuvo derecho y ese hombre ha muerto) con una oscura pasionaria en la mano, viéndola como nadie la ha visto, aunque la mirara desde el crepúsculo del día hasta el de la noche, toda una vida entera.

Jorge Luis Borges - Funes, el memorioso

Funes

pipeline workflow crates.io docs.rs License: MIT Changelog Code of Conduct

funes is a server to mock API responses. You might use it to:

  • test applications without hitting production resources;
  • create integrations tests for your applications;

Installation

To install funes, you must have rust and cargo installed. Then you can run:

cargo install funes

Usage

Now you can run your funes server in one terminal and make requests from another one:

funes

[2021-09-08T23:29:17Z INFO  funes::server] ENVS: Envs { allow_externals: true, api_regex: ".+", h_server: "funes", h_user_agent: "funes", latency_collection: "none", latency_enable: false, localhost: "0.0.0.0:8080", log: "funes,actix_web=info", mock_dir: "./mocks" }, LATENCY_COLLECTION: {}

To mock the requests of an API, call the endpoint http://localhost:8080/{API}. The first request will hit the API and then store the response:

curl http://localhost:8080/jsonplaceholder.typicode.com/todos/1

[2021-09-08T23:42:27Z DEBUG funes::handlers] File not found! For api: jsonplaceholder.typicode.com/todos/1, resource: ./mocks/2573568215281262167.json
[2021-09-08T23:42:27Z DEBUG funes::handlers] External get to: http://jsonplaceholder.typicode.com/todos/1
[2021-09-08T23:42:27Z DEBUG funes::io] Write filename: ./mocks/2573568215281262167.json
[2021-09-08T23:42:27Z INFO  actix_web::middleware::logger] 201 0.125973 GET /jsonplaceholder.typicode.com/todos/1 HTTP/1.1 curl/7.64.1 bytes:66

The second request and all the subsequent ones will be served from the stored response:

curl http://localhost:8080/jsonplaceholder.typicode.com/todos/1

[2021-09-08T23:43:06Z INFO  actix_web::middleware::logger] 200 0.000330 GET /jsonplaceholder.typicode.com/todos/1 HTTP/1.1 curl/7.64.1 bytes:66

Posts are supported:

curl \
  -d '{ "userId": 1, "id": 1, "title": "title", "body": "body" }' \
  -H "Content-Type: application/json" \
  -X POST 0.0.0.0:8080/jsonplaceholder.typicode.com/posts

[2021-09-01T04:25:01Z DEBUG funes::handlers] File not found! For api: jsonplaceholder.typicode.com/posts, resource: ./mocks/768531861528487606.json, payload_post: {"body":"body","id":1,"title":"title","userId":1}
[2021-09-01T04:25:01Z DEBUG funes::fetch] External post to: http://jsonplaceholder.typicode.com/posts
[2021-09-01T04:25:02Z DEBUG funes::utils] Write filename: ./mocks/768531861528487606.json
[2021-09-01T04:25:02Z INFO  actix_web::middleware::logger] 201 0.293888 POST /jsonplaceholder.typicode.com/posts HTTP/1.1 curl/7.64.1 bytes:51

Routes

These are the default routes of a funes app:

  • localhost:8080/{api_to_mock} - Like localhost:8080/pokeapi.co/api/v2/pokemon/1
  • localhost:8080/mocks - List of all saved mocks
  • localhost:8080/health
  • localhost:8080/resource-status

Default Envs

FUNES_ALLOW_EXTERNALS=true
FUNES_APP=funes
FUNES_HOST=0.0.0.0:8080
FUNES_LOG=funes,actix_web=info
FUNES_MOCK_DIR="./mocks"

Examples

All examples can be found in the examples folder:

Benchmarks

Funes is really fast! Take a look:

wrk -t2 -c10 -d60s http://localhost:8080/pokeapi.co/api/v2/pokemon/1

Running 1m test @ http://localhost:8080/pokeapi.co/api/v2/pokemon/1
  2 threads and 10 connections
  Thread Stats   Avg      Stdev     Max   +/- Stdev
    Latency    14.63ms  106.45ms   1.29s    97.81%
    Req/Sec    11.12k     1.69k   13.18k    86.18%
  1298872 requests in 1.00m, 241.39GB read
Requests/sec:  21630.87
Transfer/sec:      4.02GB

Modules

server