https://github.com/prongbang/wiremock

Minimal Mock your APIs
https://github.com/prongbang/wiremock

docker golang json mock-api mock-apis mock-server wiremock yml

Last synced: 10 days ago
JSON representation

Minimal Mock your APIs

• Host: GitHub
• URL: https://github.com/prongbang/wiremock
• Owner: prongbang
• License: mit
• Created: 2020-04-03T05:54:49.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-11T16:16:18.000Z (about 2 years ago)
• Last Synced: 2025-10-04T18:48:49.106Z (18 days ago)
• Topics: docker, golang, json, mock-api, mock-apis, mock-server, wiremock, yml
• Language: Go
• Homepage: https://hub.docker.com/r/prongbang/wiremock
• Size: 52.7 KB
• Stars: 10
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Wiremock [![Docker Pulls](https://img.shields.io/docker/pulls/prongbang/wiremock.svg)](https://hub.docker.com/r/prongbang/wiremock/) [![Image Size](https://img.shields.io/docker/image-size/prongbang/wiremock.svg)](https://hub.docker.com/r/prongbang/wiremock/)

> [Wiremock](https://hub.docker.com/r/prongbang/wiremock) Minimal Mock your APIs 

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/prongbang)

```shell script

  _      ___                        __  

 | | /| / (_)______ __ _  ___  ____/ /__

 | |/ |/ / / __/ -_)  ' \/ _ \/ __/  '_/

 |__/|__/_/_/  \__/_/_/_/\___/\__/_/\_\

 -> wiremock server started on :8000

```

### Run with Docker

```shell

docker pull prongbang/wiremock:latest

```

### Run with Docker Compose

```yaml

version: '3.7'

services:

  app_wiremock:

    image: prongbang/wiremock:latest

    ports:

      - "8000:8000"

    volumes:

      - "./mock:/mock"

    environment:

      - ORIGIN_ALLOWED=http://localhost:9000

```

```

$ docker-compose up -d

```

### Run with Golang

```shell script

$ go install github.com/prongbang/wiremock/v2@latest

```

#### Default port `8000`

```bash

$ wiremock

```

#### Custom port `9000`

```bash

$ wiremock -port=9000

```

### Example Project

[https://github.com/prongbang/wiremock-example](https://github.com/prongbang/wiremock-example)

## Matching Routes using gorilla/mux

Read doc [gorilla/mux](https://github.com/gorilla/mux#matching-routes)

## Setup project

```shell script

project

├── docker-compose.yml

└── mock

    ├── login

    │   └── route.yml

    └── user

        ├── response

        │   └── user.json

        └── route.yml

```

#### Login

```shell script

POST http://localhost:8000/api/v1/login

Query

  lang: "th"

Header

  Api-Key: "ed2b7d14-3999-408e-9bb8-4ea739f2bcb5"

Body

{

  "username": "admin"

  "password": "pass"

}

```

- route.yml

```yaml

routes:

  login:

    request:

      method: "POST"

      url: "/api/v1/login"

      query:

        lang: "th" 

      header:

        Api-Key: "ed2b7d14-3999-408e-9bb8-4ea739f2bcb5"

      body:

        username: "admin"

        password: "pass"

    response:

      status: 200

      body: >

        {"message": "success"}

```

#### User

```shell script

GET   http://localhost:8000/api/v1/user/1

POST  http://localhost:8000/api/v1/user

```

- route.yml

```yaml

routes:

  get_user:

    request:

      method: "GET"

      url: "/api/v1/user/{id:[0-9]+}"

    response:

      status: 200

      body_file: user.json

  create_user:

    request:

      method: "POST"

      url: "/api/v1/user"

    response:

      status: 201

      body: >

        {"message": "success"}

```

### User with multiple case

```*``` - field required.

```yaml

routes:

  users:

    request:

      method: "POST"

      url: "/api/v1/user"

      query:

        lang: "XYZ"

      header:

        Api-Key: "ABC"

      cases:

        user_accept_consent:

          body:

            action: "consent"

            accept: "Y"

          response:

            status: 200

            body_file: user-accept-consent.json

        get_profile:

          body:

            username: "*"

            userId: "*"

          response:

            status: 200

            body_file: profile-self.json

```