Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danielgtaylor/apisprout
Lightweight, blazing fast, cross-platform OpenAPI 3 mock server with validation
https://github.com/danielgtaylor/apisprout
docker-image examples hacktoberfest mock-server openapi openapi3
Last synced: 2 days ago
JSON representation
Lightweight, blazing fast, cross-platform OpenAPI 3 mock server with validation
- Host: GitHub
- URL: https://github.com/danielgtaylor/apisprout
- Owner: danielgtaylor
- License: mit
- Created: 2018-07-24T05:29:01.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-28T15:41:40.000Z (about 2 years ago)
- Last Synced: 2024-11-15T04:38:06.608Z (28 days ago)
- Topics: docker-image, examples, hacktoberfest, mock-server, openapi, openapi3
- Language: Go
- Homepage:
- Size: 172 KB
- Stars: 699
- Watchers: 13
- Forks: 74
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-blazingly-fast - apisprout - Lightweight, blazing fast, cross-platform OpenAPI 3 mock server with validation (Go)
README
[](https://goreportcard.com/report/github.com/danielgtaylor/apisprout) [](https://travis-ci.org/danielgtaylor/apisprout) [](https://github.com/danielgtaylor/apisprout/releases) [](https://hub.docker.com/r/danielgtaylor/apisprout/)
A simple, quick, cross-platform API mock server that returns examples specified in an API description document. Features include:
- OpenAPI 3.x support
- Uses operation `examples` or generates examples from `schema`
- Load from a URL or local file (auto reload with `--watch`)
- CORS headers enabled by default
- Accept header content negotiation
- Example: `Accept: application/*`
- Prefer header to select response to test specific cases
- Example: `Prefer: status=409`
- Server validation (enabled with `--validate-server`)
- Validates scheme, hostname/port, and base path
- Supports `localhost` out of the box
- Use the `--add-server` flag, in conjunction with `--validate-server`, to dynamically include more servers in the validation logic
- Request parameter & body validation (enabled with `--validate-request`)
- Configuration via:
- Files (`/etc/apisprout/config.json|yaml`)
- Environment (prefixed with `SPROUT_`, e.g. `SPROUT_VALIDATE_SERVER`)
- Commandline flags
Usage is simple:
```sh
# Load from a local file
apisprout my-api.yaml
# Validate server name and use base path
apisprout --validate-server my-api.yaml
# Dynamically Include a new server / path in the validation
apisprout --add-server http://localhost:8080/mock --validate-server my-api.yaml
# Load from a URL
apisprout https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/api-with-examples.yaml
```
## Docker Image
A hosted [API Sprout Docker image](https://hub.docker.com/r/danielgtaylor/apisprout/) is provided that makes it easy to deploy mock servers or run locally. For example:
```sh
docker pull danielgtaylor/apisprout
docker run -p 8000:8000 danielgtaylor/apisprout http://example.com/my-api.yaml
```
Configuration can be passed via environment variables, e.g. setting `SPROUT_VALIDATE_REQUEST=1`, or by passing commandline flags. It is also possible to use a local API description file via [Docker Volumes](https://docs.docker.com/storage/volumes/):
```
# Remember to put the full path to local archive YAML in -v
docker run -p 8000:8000 -v $FULLPATH/localfile.yaml:/api.yaml danielgtaylor/apisprout /api.yaml
```
## Installation
Download the appropriate binary from the [releases](https://github.com/danielgtaylor/apisprout/releases) page.
Alternatively, you can use `go get`:
```sh
go get github.com/danielgtaylor/apisprout
```
## Extra Features
### Remote Reload
If your API spec is loaded from a remote URL, you can live-reload it by hitting the `/__reload` endpoint.
### Health Check
A simple endpoint which returns status code `200` is available at `/__health`. This endpoint successfully returns `200` even if `--validate-server` is turned on, and the endpoint is being accessed from a non-validated host.
## Contributing
Contributions are very welcome. Please open a tracking issue or pull request and we can work to get things merged in.
## Release Process
The following describes the steps to make a new release of API Sprout.
1. Merge open PRs you want to release.
1. Select a new semver version number (major/minor/patch depending on changes).
1. Update `CHANGELOG.md` to describe changes.
1. Create a commit for the release.
1. Tag the commit with `git tag -a -m 'Tagging x.y.z release' vx.y.z`.
1. Build release binaries with `./release.sh`.
1. Push the commit and tags.
1. Upload the release binaries.
## License
Copyright © 2018-2019 Daniel G. Taylor
http://dgt.mit-license.org/