davyj0nes/stubby

Stubby

https://goreportcard.com/badge/github.com/davyj0nes/stubby](https://goreportcard.com/report/github.com/davyj0nes/stubby) https://travis-ci.org/DavyJ0nes/stubby.svg?branch=master](https://travis-ci.org/DavyJ0nes/stubby) https://img.shields.io/badge/docker-info-blue?style=flat&logo=docker](https://hub.docker.com/repository/docker/davyj0nes/stubby/general)

镜像概述

Stubby是一个用于生成存根HTTP响应的工具，通过配置文件定义路由和响应内容，帮助开发者快速模拟API接口，适用于测试和开发环境。

核心功能

• 自定义路由：设置路径、状态码和响应内容
• 支持URL查询参数：根据参数返回不同响应
• 自定义响应头：添加自定义HTTP头到响应中

使用场景

• API测试：模拟后端接口返回固定响应验证前端逻辑
• 前端开发：在后端接口未完成时提供模拟数据
• 集成测试：稳定存根响应确保测试用例可重复执行

配置说明

基础配置

在config.yaml中定义路由：

yaml
routes:
  - path: /foo
    status: 200
    response: >-
      {
        "id": 123,
        "message": "foo"
      }

URL查询参数配置

针对带查询参数的请求返回特定响应：

yaml
routes:
  - path: /foo
    queries:
      - show_deleted
      - true
    status: 200
    response: >-
      {
        "id": 987,
        "message": "bar"
      }

自定义响应头配置

添加自定义HTTP头：

yaml
routes:
  - path: /foo
    status: 200
    headers:
      X-Custom: Header
      X-Request-Id: ef835eaf-a658-458b-86ae-d2d771f5e745
    response: >-
      {
        "id": 987,
        "message": "bar"
      }

Docker部署示例

本地运行

bash
docker run --rm -v "$PWD/config.yaml:/bin/config.yaml" -p 8080:8080 davyj0nes/stubby

说明：将本地config.yaml挂载到容器内，映射8080端口到主机，启动Stubby服务。

贡献指南

若需贡献代码，请参考项目的https://github.com/davyj0nes/stubby/blob/master/CONTRIBUTING.md%E3%80%82

许可证

本项目使用https://github.com/davyj0nes/stubby/blob/master/LICENSE%E3%80%82