Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/theinkedengineer/espresso-martini

A Vapor-powered, Swift mock server for iOS, macOS applications as well as a local server.
https://github.com/theinkedengineer/espresso-martini

ios macos mock mock-server server swift

Last synced: 3 days ago
JSON representation

A Vapor-powered, Swift mock server for iOS, macOS applications as well as a local server.

Host: GitHub
URL: https://github.com/theinkedengineer/espresso-martini
Owner: TheInkedEngineer
Created: 2022-11-20T17:36:09.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-02-27T10:02:06.000Z (almost 2 years ago)
Last Synced: 2023-03-11T06:53:22.267Z (almost 2 years ago)
Topics: ios, macos, mock, mock-server, server, swift
Language: Swift
Homepage:
Size: 434 KB
Stars: 26
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

[![Twitter](https://img.shields.io/twitter/url/https/theinkedgineer.svg?label=TheInkedgineer&style=social)](https://twitter.com/inkedengineer)
![SwiftLang badge](https://img.shields.io/badge/language-Swift%205.6-orange.svg)

# Espresso Martini

`Espresso Martini` is a vapor-powered mock server. It allows you you to mock HTTP requests easily, so you worry about the things that matter, and not have to wait on APIs to be live.

Just configure your request/response pairs, known as `NetworkExchange`, run the server, and you are good to go. Requests made to the configured hostname and port will be intercepted and the server will return any desired response.

It supports different types of data, response headers and all HTTP response codes.

The library is fully tested and documented.

# 1. Requirements and Compatibility

- Xcode 13.2+
- Swift 5.6+
- iOS 13+
- macOS 12+

> When running on iOS you will get a threading warning, which is a [known issue](https://github.com/apple/swift-nio/issues/2223) with NIO and can be safely ignored.

# 2. Roadmap

- [x] Add support for folder based request/response pairs
- [x] Add support for a global delay
- [x] Add support for a delay on a per `networkExchange` basis
- [x] Add a CLI
- [x] Add support for retry-able request
- [x] Add support for polling requests
- [ ] Add support for customised response based on query parameters

# 3. Installation

## Swift Package Manager

#### Package.swift

Open your `Package.swift` file and add the following as your dependency.

```swift
dependencies: [
.package(url: "https://github.com/TheInkedEngineer/Espresso-Martini", from: "1.0.0")
]
```

Then add the following to your target's dependency:

```swift
targets: [
.target(
name: "MyTarget",
dependencies: [
.product(name: "https://github.com/TheInkedEngineer/Espresso-Martini", package: "Espresso-Martini")
]
)
]
```

#### Xcode

1. Open your app in Xcode
1. In the **Project Navigator**, click on the project
1. in the Project panel, click on the project
1. Go to the **Package Dependencies** tab
1. Click on the `+` button
1. Insert the `https://github.com/TheInkedEngineer/Espresso-Martini` url in the search bar and press **Enter**
1. Click on the `Add Package` button
1. Follow the Xcode's dialog to install the SDK

## CLI

1. Clone the repo `git clone [email protected]:TheInkedEngineer/Espresso-Martini.git`
1. `cd Espresso-Martini`
1. `make` -- you might need to run it with `sudo` privileges.

# 4. Documentation

[Here](DOCUMENTATION.md) is a dedicated markdown file containing the documentation.

# 5. Contribution

**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)