Skip to content

Commit

Permalink
First commit
Browse files Browse the repository at this point in the history
  • Loading branch information
danielgtaylor committed Jul 24, 2018
0 parents commit 517362a
Show file tree
Hide file tree
Showing 6 changed files with 402 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.DS_Store
vendor
logo.png
137 changes: 137 additions & 0 deletions Gopkg.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

46 changes: 46 additions & 0 deletions Gopkg.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Gopkg.toml example
#
# Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md
# for detailed Gopkg.toml documentation.
#
# required = ["github.com/user/thing/cmd/thing"]
# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
#
# [[constraint]]
# name = "github.com/user/project"
# version = "1.0.0"
#
# [[constraint]]
# name = "github.com/user/project2"
# branch = "dev"
# source = "github.com/myfork/project2"
#
# [[override]]
# name = "github.com/x/y"
# version = "2.4.0"
#
# [prune]
# non-go = false
# go-tests = true
# unused-packages = true


[prune]
go-tests = true
unused-packages = true

[[constraint]]
branch = "master"
name = "github.com/getkin/kin-openapi"

[[constraint]]
name = "github.com/spf13/viper"
version = "1.0.2"

[[constraint]]
name = "github.com/spf13/cobra"
version = "0.0.3"

[[constraint]]
name = "gopkg.in/yaml.v2"
version = "2.2.1"
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
![API Sprout](https://user-images.githubusercontent.com/106826/43119494-78be9224-8ecb-11e8-9d1a-9fc6f3014b91.png)

A simple, quick, cross-platform API mock server that returns examples specified in an OpenAPI 3.x document. Usage is simple:

```sh
apisprout my-api.yaml
```

## ToDo

[x] OpenAPI 3.x support
[x] Return defined examples
[ ] Validate request payload
[ ] Take `Accept` header into account to return the right media type
[ ] Generate fake data from schema if no example is available
[ ] Release binaries for Windows / Mac / Linux
[ ] Public Docker image

## License

Copyright © 2018 Daniel G. Taylor

http://dgt.mit-license.org/
Loading

0 comments on commit 517362a

Please sign in to comment.