-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
skip-ci
- Loading branch information
Showing
1 changed file
with
20 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,34 @@ | ||
| <h1> | ||
| <img src="https://github.com/natenho/Mockaco/raw/master/src/Mockaco/Resources/mockaco-logo.svg" width="64px" height="64px" alt="Mockaco"> | ||
| Mockaco | ||
| </h1> | ||
| <p align="center"> | ||
| <img src="https://github.com/natenho/Mockaco/raw/master/src/Mockaco/Resources/mockaco-logo.svg" width="96px" height="96px" alt="Mockaco"> | ||
| </p> | ||
|
|
||
| Mockaco is an HTTP-based API mock server with fast setup. | ||
| # Mockaco | ||
|
|
||
| [](https://github.com/natenho/Mockaco/actions/workflows/main-release.yml) [](https://hub.docker.com/repository/docker/natenho/mockaco) [](https://www.nuget.org/packages/Mockaco/) [](https://app.fossa.com/projects/git%2Bgithub.com%2Fnatenho%2FMockaco?ref=badge_shield) | ||
|
|
||
| ## Documentation | ||
|
|
||
| Access the docs on [natenho.github.io/Mockaco](https://natenho.github.io/Mockaco/) | ||
| Mockaco is an HTTP-based API mock server with fast setup. | ||
|
|
||
| ## Features | ||
|
|
||
| - Simple JSON-based configuration | ||
| - Pure C# scripting - you don't need to learn a new specific language or API to configure your mocks | ||
| - Fake data generation - built-in fake data generation | ||
| - Callback support - trigger another service call when a request hits your mocked API | ||
| - State support - stateful mock support allow a mock to be returned based on a global variable previously set by another mock | ||
| - Portable - runs in any [.NET Core compatible environment](https://github.com/dotnet/core/blob/main/release-notes/5.0/5.0-supported-os.md) | ||
|
|
||
| [](https://www.youtube.com/watch?v=QBnXCgZFzM0 "Mocking APIs with Mockaco | .NET 7") | ||
|
|
||
| # Get Started | ||
|
|
||
| ## Running the application | ||
|
|
||
| ### .NET CLI | ||
|
|
||
| Install and run as a dotnet tool: | ||
|
|
||
| ```console | ||
| $ dotnet tool install -g mockaco | ||
| $ mockaco --urls "http://localhost:5000" | ||
| ``` | ||
|
|
||
| A random local port is chosen if `--urls` parameter is not provided. | ||
| - **Simple JSON-based Configuration**: Configure your mocks easily using a simple JSON format. | ||
| - **Pure C# Scripting**: Configure your mocks using C# scripting without the need to learn a new language or API. | ||
| - **Delay Simulation**: Simulate network delays to test how your system handles timeouts and latency. | ||
| - **Fake Data Generation**: Generate realistic fake data using the built-in functionality. | ||
| - **Callback (Webhook) Support**: Trigger another service call when a request hits your mocked API. | ||
| - **Verification**: Verify if a specific mock was called during testing to ensure expected interactions. | ||
| - **State Support**: Create stateful mocks that return responses based on global variables previously set by other mocks. | ||
| - **Portability**: Run the mock server in [any environment supported by .NET](https://github.com/dotnet/core/blob/main/release-notes/6.0/supported-os.md). | ||
|
|
||
| ### Docker | ||
| ## Get Started | ||
|
|
||
| You can run Mockaco from the official [Docker image](https://hub.docker.com/r/natenho/mockaco) (replace ```/your/folder``` with an existing directory of your preference): | ||
| Access the documentation on <strong>[natenho.github.io/Mockaco](https://natenho.github.io/Mockaco/)</strong> | ||
|
|
||
| ```console | ||
| $ docker run -it --rm -p 5000:5000 -v /your/folder:/app/Mocks natenho/mockaco | ||
| ``` | ||
|
|
||
| The port exposed by the container is 5000 (HTTP) by default. | ||
|
|
||
| ### Sources | ||
|
|
||
| Or your can run it directly from sources: | ||
|
|
||
| ```console | ||
| $ git clone https://github.com/natenho/Mockaco.git | ||
| $ cd Mockaco\src\Mockaco | ||
| $ dotnet run | ||
| ``` | ||
|
|
||
| A random local port is chosen if `--urls` parameter is not provided. | ||
| [](https://www.youtube.com/watch?v=QBnXCgZFzM0 "Mocking APIs with Mockaco | .NET 7") | ||
|
|
||
| -- | ||
| ## License | ||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fnatenho%2FMockaco?ref=badge_large) | ||
|
|
||
| Icon made by [Freepik](https://www.freepik.com/ "Freepik") from [www.flaticon.com](https://www.flaticon.com/ "Flaticon") is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/ "Creative Commons BY 3.0") | ||
| --- | ||
|
|
||
| *Icon made by [Freepik](https://www.freepik.com/ "Freepik") from [www.flaticon.com](https://www.flaticon.com/ "Flaticon") is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/ "Creative Commons BY 3.0")* | ||
|
|
||
| ## License | ||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fnatenho%2FMockaco?ref=badge_large) |