首页
/ Mimic 使用与技术文档

Mimic 使用与技术文档

2024-12-20 14:30:55作者:伍霜盼Ellen

1. 安装指南

Mimic 是一个用于测试的简单 Web 服务存根工具。以下是安装 Mimic 的步骤:

  1. 确保您的系统中已安装 Ruby。

  2. 使用 gem 命令安装 Mimic:

    gem install mimic
    
  3. 安装 daemons gem 以运行 Mimic 作为守护进程:

    gem install daemons
    

2. 项目的使用说明

Mimic 允许您为外部 Web 服务创建一个假的替代品,以便在编写集成/端到端测试时使用。以下是如何使用 Mimic:

注册单个请求存根

Mimic.mimic.get("/some/path").returning("hello world")

使用 RestClient 获取响应

$ RestClient.get("http://www.example.com:11988/some/path") # => 200 | hello world

注册多个请求存根

Mimic.mimic do
  get("/some/path").returning("Hello World", 200)
  get("/some/other/path").returning("Redirecting...", 301, {"Location" => "somewhere else"})
  post("/some/path").returning("Created!", 201)
end

使用 Rack 中间件

Mimic.mimic do
  use Rack::Auth::Basic do |user, pass|
    user == 'theuser' and pass == 'thepass'
  end

  get("/some/path")
end

在 Sinatra 应用中创建存根请求

Mimic.mimic do
  get "/some/path" do
    [200, {}, "hello world"]
  end
end

3. 项目API使用文档

Mimic 提供了一个内置的 REST API,允许您通过 HTTP 配置请求存根。以下是使用 Mimic REST API 的步骤:

将 Mimic 运行成守护进程

创建一个简单的 Ruby 脚本并使用 daemons gem:

#!/usr/bin/env ruby
require 'mimic'
require 'daemons'

Daemons.run_proc("mimic") do
  Mimic.mimic(:port => 11988, :fork => false, :remote_configuration_path => '/api') do
    # 在这里配置您的存根
  end
end

给脚本执行权限并启动它:

$ your_mimic_script.rb start (或 run)

使用 REST API 配置存根

例如,以下是如何使用 REST API 配置前面提到的 GET 请求存根:

$ curl -d'{"path":"/some/path", "body":"hello world"}' http://localhost:11988/api/get

类似地,以下是如何为同一路径配置 POST 请求存根:

$ curl -d'{"path":"/some/path", "body":"hello world"}' http://localhost:11988/api/post

API 端点是对应的 HTTP 谓词,路径、响应体、状态码和头信息在 POST 数据中指定(JSON 或 Plist 格式的哈希)。

4. 项目安装方式

请参考上述“安装指南”部分。

以上是 Mimic 项目的使用和技术文档。希望这些信息对您有所帮助!

登录后查看全文
热门项目推荐