Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/outofcoffee/imposter
Scriptable, multipurpose mock server. Run standalone mock servers, or embed mocks within your tests.
https://github.com/outofcoffee/imposter
api-mock hbase mock mock-responses mock-server openapi rest-api salesforce soap swagger
Last synced: 6 days ago
JSON representation
Scriptable, multipurpose mock server. Run standalone mock servers, or embed mocks within your tests.
- Host: GitHub
- URL: https://github.com/outofcoffee/imposter
- Owner: outofcoffee
- License: other
- Created: 2016-04-06T20:08:37.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-12-12T11:47:08.000Z (about 1 month ago)
- Last Synced: 2024-12-30T15:14:45.594Z (12 days ago)
- Topics: api-mock, hbase, mock, mock-responses, mock-server, openapi, rest-api, salesforce, soap, swagger
- Language: Kotlin
- Homepage: https://imposter.sh
- Size: 14.1 MB
- Stars: 374
- Watchers: 10
- Forks: 61
- Open Issues: 62
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: COPYING
- Security: docs/security.md
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
- trackawesomelist - Imposter (⭐364) (⭐362) - Mock server for REST APIs, OpenAPI (and Swagger) specifications, SOAP web services (and WSDL files), Salesforce and HBase APIs. (Recently Updated / [Oct 02, 2024](/content/2024/10/02/README.md))
- awesome-integration - Imposter (⭐376) - Mock server for REST APIs, OpenAPI (and Swagger) specifications, SOAP web services (and WSDL files), Salesforce and HBase APIs. (Projects / API Testing)
README
# Imposter: Scriptable, multipurpose mock server
[](https://github.com/outofcoffee/imposter/actions/workflows/cicd.yaml)
> Mock server for REST APIs, OpenAPI (and Swagger) specifications, SOAP web services (and WSDL files), Salesforce and HBase APIs.
>
> - Run **standalone** mock servers in Docker, Kubernetes, AWS Lambda or on the JVM.
> - **Embed** mocks within your tests (JVM or Node.js) to remove external dependencies.
> - Script **dynamic** responses using JavaScript, Groovy or Java.
> - **Capture** data from requests, then store it or return a **templated** response.
> - **Proxy** an existing endpoint to replay its responses as a mock.
## [Read the documentation here](https://docs.imposter.sh/)
## Features
- run standalone mocks in place of real systems
- turn an OpenAPI/Swagger file or WSDL file into a mock API for dev or QA (use it before the real API is built)
- decouple your integration tests from the cloud/back-end systems and take control of your dependencies
- validate your API requests against an OpenAPI specification
- capture data to retrieve later, or use in templates to for conditional responses
- proxy an existing endpoint to replay its responses as a mock
Send dynamic responses:
- Provide mock responses using static files or customise behaviour based on characteristics of the request.
- Power users can control mock responses with JavaScript or Java/Groovy script engines.
- Advanced users can write their own plugins in a JVM language of their choice.
## Getting started
The quickest way to get up and running is to use the free cloud-hosted service at **[mocks.cloud](https://www.mocks.cloud)**
## User documentation
**[Read the user documentation here](https://docs.imposter.sh/)**
## Tutorials
- [Mocking APIs with OpenAPI and Imposter](https://medium.com/@outofcoffee/mocking-apis-with-swagger-and-imposter-3694bd1733c0)
- [Mocking REST APIs with Imposter](https://medium.com/@outofcoffee/mocking-apis-with-imposter-53bd908632e5)
- [Mocking SOAP web services with Imposter](https://medium.com/@outofcoffee/mocking-soap-web-services-with-imposter-da8e9666b5b4)
*****
## Mock types
Imposter provides specialised mocks for the following scenarios:
- **[OpenAPI](docs/openapi_plugin.md)** - Support for OpenAPI (and Swagger) API specifications.
- **[REST](docs/rest_plugin.md)** - Mocks RESTful or plain HTTP APIs.
- **[SOAP](docs/soap_plugin.md)** - Support for SOAP web services (and WSDL files).
- **[HBase](docs/hbase_plugin.md)** - Basic HBase mock implementation.
- **[SFDC (Salesforce)](docs/sfdc_plugin.md)** - Basic Salesforce mock implementation.
- **[WireMock](docs/wiremock_plugin.md)** - Support for WireMock mappings files.
These use a plugin system, so you can also create your own plugins, using any JVM language.
## Example
```shell
$ imposter up
Starting server on port 8080...
Parsing configuration file: someapi-config.yaml
...
Mock server is up and running
```
Your mock server is now running! Here Imposter provides HTTP responses to simulate an API that accepts users and returns a dynamic response containing the user ID from the request.
```shell
$ curl -v -X PUT http://localhost:8080/users/alice
HTTP/1.1 201 Created
Content-Type: application/json
{ "userName": "alice" }
```
This is a trivial example, which you can extend with conditional logic, request validation, data capture and much more...
## How to run Imposter
There are many ways to run Imposter.
### Standalone mock server
- Using the command line client - see [Imposter CLI](./docs/run_imposter_cli.md)
- As a Docker container - see [Imposter Docker container](./docs/run_imposter_docker.md)
- As a Lambda function in AWS - see [Imposter AWS Lambda](./docs/run_imposter_aws_lambda.md)
- As a JAR file on the JVM - see [Imposter JAR file](./docs/run_imposter_jar.md)
### Embedded in tests
- Embedded within your **Java/Kotlin/Scala/JVM** unit tests - see [JVM bindings](./docs/embed_jvm.md)
- Embedded within your **JavaScript/Node.js** unit tests - see [JavaScript bindings](https://github.com/gatehill/imposter-js)
---
## Recent changes and Roadmap
For recent changes see the [Changelog](CHANGELOG.md), or view the [Roadmap](docs/roadmap.md).
## Contributing
- Pull requests are welcome.
- PRs should target the `develop` branch.
## Author
Pete Cornish ([email protected])