mockapi

README

MockAPI

A simple API service written in go, this API service is designed to get simple API's up and running without any external dependencies, such as runtimes or libraries.

Description

MockAPI is intended to be simple to use and configure as it uses YAML as a configuration language. It currently boasts the following core features:

• ✅ Multiple web listeners, capable of listening on different ports similtaniously, either on HTTP or HTTPs
• ✅ Multiple content bindings, which are attached to a listener definition, which return headers, response codes, body data and datatypes independently of one-another.
• ✅ Inline content delivery such as simple text, whether this be HTML, JSON, CSV etc, it doesn't matter as it's treated as a simple string.
• ✅ File based content delivery from simple text based formats (currently; .html, .json, .xml, .txt and .csv data formats are supported).
• ✅ KVP based header support in server responses. Return whatever you want in your headers!

MockAPI also limits the amount of third party golang libaries used, this is intended to keep the contributors(s) to the codebase from extending the feature-set beyond the intended scope of this project, in a simple manner of speaking "to keep it simple, stupid". This also has the added benefit of limiting potential supply chain attacks.

As this program is written in go, it is platform agnostic. It is intended to be freely compabile with both BSD, linux and windows.

Getting Started

Dependencies

To compile:

• Golang 1.21.3 - This is the current build target.
• make - To run make.

Installing

The make file will build this binary in portable format, you can run it from where-ever you like! Simply:

• Clone the Repo:

git clone https://github.com/NRException/MockAPI
cd MockAPI

• And build:

make build

• Finally, copy the relevent binary from the build/bsd,linux or windows folder to wherever you like!

Executing program

• Help prompt:

./mockapi -h

• Run MockAPI from a single configuration file (non-verbose):

./mockapi -f <inputfile>

• Run MockAPI from a single configuration file (verbose):

./mockapi -f <inputfile> -v

Formatting Settings

mockapi uses yaml for its configuration language, it uses a set of simplified parameters to define listeners and their configuration. A very simple configuration file for mockapi would look something like below:

id: "primary_settings"
schema: "http://json-schema.org/draft-07/schema#"
description: "Basic Schema borrowed from URL in schema field..."
weblisteners:                             # N array of web listeners...
  - listenername: "Primary Listener"      # friendly name of the web listener
    listenerport: 8080                    # port to listen on
    onconnectkeepalive: true              # whether or not to immediately close connection when response given.
    enabletls: false                      # enable tls on the listener?
    #certdetails:                         # if enabletls is equal to true, provide the paths to the cert and key...
    #  certfile: cert.cer
    #  keyfile: key.cer
    contentbindings:                      # N array of static content bindings.
      - bindingpath: "/"                  # "directory" to bind to.
        responseheaders:                  # N array of headers to pass
          - headerkey: "content-type"     # Header Key
            headervalue: "text/plain"     # Header Value
        responsecode: 200                 # Response code to return
        responsebodytype: "inline"        # Type of content to return. use "responsebody" to return static content. Possible values are "static", "proxy", and "file"
        responsebody: "You're in the root" # Body of response to return, can be a file if responsebodytype is set to "file"

      - bindingpath: "/json"
        responseheaders:
          - headerkey: "content-type"
            headervalue: "text/json"
        responsecode: 200
        responsebodytype: "file"          
        responsebody: "build/test.json"

For more information, please refer to the wiki.

Help

Any bug reports, or insight required into unexpected behaviour should be logged with the -v (verbose) switch as this will provide a full context of what the application is doing exactly. eg:

./mockapi <switches> -v

Authors

• Cameron Huggett
• Eric Wohltman

License

This project is licensed under the GNU GENERAL PUBLIC license - see the LICENSE.md file for details

Acknowledgments

• simple-readme - For the readme you're currently reading
• go-yaml - For yaml support
• go uuid - For UUID generation