Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/muonsoft/openapi-mock

OpenAPI mock server with random data generation
https://github.com/muonsoft/openapi-mock

mock mock-server openapi openapi3 swagger

Last synced: 6 days ago
JSON representation

OpenAPI mock server with random data generation

Host: GitHub
URL: https://github.com/muonsoft/openapi-mock
Owner: muonsoft
License: mit
Created: 2018-08-21T18:16:27.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2024-06-27T19:33:08.000Z (5 months ago)
Last Synced: 2024-08-01T21:41:38.008Z (3 months ago)
Topics: mock, mock-server, openapi, openapi3, swagger
Language: Go
Homepage:
Size: 997 KB
Stars: 482
Watchers: 9
Forks: 54
Open Issues: 21
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # OpenAPI Mock Server

![CI](https://github.com/muonsoft/openapi-mock/workflows/CI/badge.svg?branch=master)

![GitHub release (latest by date)](https://img.shields.io/github/v/release/muonsoft/openapi-mock)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/muonsoft/openapi-mock/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/muonsoft/openapi-mock/?branch=master)

[![Maintainability](https://api.codeclimate.com/v1/badges/158deb3434a84924dade/maintainability)](https://codeclimate.com/github/muonsoft/openapi-mock/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/158deb3434a84924dade/test_coverage)](https://codeclimate.com/github/muonsoft/openapi-mock/test_coverage)

OpenAPI API mock server with random data generation by specified schemas.

* OpenAPI 3.x support.

* Load specification from a local file or URL.

* JSON and YAML format supported.

* Generates fake response data by provided schemas or by examples.

* Content negotiation by Accept header.

* Can be used as standalone application (Linux and Windows) or can be run via Docker container.

## Supported features

| Feature | Support status |

| --- | --- |

| generating xml response | basic support ([without xml tags](https://swagger.io/docs/specification/data-models/representing-xml/)) |

| generating json response | supported |

| generation of [basic types](https://swagger.io/docs/specification/data-models/data-types/) | supported |

| generation of [enums](https://swagger.io/docs/specification/data-models/enums/) | supported |

| generation of [associative arrays](https://swagger.io/docs/specification/data-models/dictionaries/) | supported |

| generation of [combined types](https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/) | supported (without tag `not` and discriminator) |

| local reference resolving | supported |

| remote reference resolving | not supported |

| URL reference resolving | not supported |

| validating request data | not supported |

| force using custom response schema | not supported (schema detected automatically) |

## Quick start

Download latest binary and run a server.

```bash

# runs a local server on port 8080

./openapi-mock serve --specification-url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml

# to test that the server successfully ran

curl 'http://localhost:8080/v1/pets'

```

Alternatively, you can use [Docker](https://www.docker.com/) image.

```bash

# downloads an image

docker pull muonsoft/openapi-mock

# runs a docker container with exported port 8080

docker run -p 8080:8080 -e "OPENAPI_MOCK_SPECIFICATION_URL=https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml" --rm muonsoft/openapi-mock

# to test that the server successfully ran

curl 'http://localhost:8080/v1/pets'

```

Also, you can use [Docker Compose](https://docs.docker.com/compose/). Example of `docker-compose.yml`

```yaml

version: '3.0'

services:

  openapi_mock:

    container_name: openapi_mock

    image: muonsoft/openapi-mock

    environment:

      OPENAPI_MOCK_SPECIFICATION_URL: 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml'

    ports:

      - "8080:8080"

```

To start up a container run command.

```bash

docker-compose up -d

```

If you want to reference a local file in docker compose:

* you must first mount the host dir into container - `./openapi:/etc/openapi`

* only then can you reference it

```yaml

version: '3.0'

services:

  openapi_mock:

    container_name: openapi_mock

    image: muonsoft/openapi-mock

    volumes:

    - ./openapi:/etc/openapi

    environment:

      OPENAPI_MOCK_SPECIFICATION_URL: '/etc/openapi/petstore.yaml'

    ports:

      - "8080:8080"

```

## Usage guide

* [Console commands](docs/usage_guide.md#console-commands)

* [Setting up a configuration](docs/usage_guide.md#setting-up-a-configuration)

* [Configuration file example](docs/usage_guide.md#configuration-file-example)

* [Configuration options](docs/usage_guide.md#configuration-options)

## License

This project is licensed under the MIT License - see the LICENSE file for details.