# Technical Documentation: dreamhead/moco

> ℹ️ **Provenance:** Standard README.md · [CodeWiki Reference](https://codewiki.google/github.com/dreamhead/moco) · Recency: Active (< 180 days)

<a href="https://github.com/dreamhead/moco">
  
</a>

# [Moco](https://github.com/dreamhead/moco) 
[](https://github.com/dreamhead/moco/actions/workflows/build.yaml)
[](http://hits.dwyl.com/dreamhead/moco)

Moco is an easy setup stub framework.

## Latest Release
* [](https://central.sonatype.com/artifact/com.github.dreamhead/moco-core)
* [Release Notes](moco-doc/ReleaseNotes.md)

**Note:** Moco 2.0.0 requires Java 17 or later.

## User Voice
* [Let me know](https://jinshuju.net/f/Agawf9) if you are using Moco.
* Join Moco [mailing list](https://groups.google.com/forum/#!forum/moco-stub) to discuss.

## Why
Integration, especially based on HTTP protocol, e.g. web service, REST etc, is wildly used in most of our development.

In the old days, we just deployed another WAR to an application server, e.g. Jetty or Tomcat etc. As we all know, it's so boring to develop a WAR and deploy it to any application server, even if we use an embeded server. And the WAR needs to be reassembled even if we just want to change a little bit.

## Quick Start
* Download [Standalone Moco Runner](https://repo1.maven.org/maven2/com/github/dreamhead/moco-runner/1.6.1/moco-runner-1.6.1-standalone.jar)
* Write your own configuration file to describe your Moco server configuration as follow:
```json
[
  {
    "response" :
      {
        "text" : "Hello, Moco"
      }
  }
]
```
(foo.json)

* Run Moco HTTP server with the configuration file.
```shell
java -jar moco-runner-<version>-standalone.jar http -p 12306 -c foo.json
```

* Now, open your favorite browser to visit http://localhost:12306 and you will see "Hello, Moco".

## Documents
* More [Usages](moco-doc/usage.md)
* Detailed [HTTP APIs](moco-doc/apis.md)
* Detailed [REST API](moco-doc/rest-apis.md)
* Detailed [Websocket API](moco-doc/websocket-apis.md)
* Detailed [SSE API](moco-doc/sse-apis.md)
* [Global Settings](moco-doc/global-settings.md) for multiple configuration files.
* [Command Line Usages](moco-doc/cmd.md)
* [Extend Moco](moco-doc/extending.md) if current API does not meet your requirement.

## Build
**Requirements:** JDK 17+ and Gradle

* Clone Moco

```shell
git clone git@github.com:dreamhead/moco.git
```
* Build Moco

```shell
./gradlew build
```
* Build uberjar

```shell
./gradlew uberjar
```
* Check code before commit

```shell
./gradlew check
```

## Contributing
Check out what you can help [here](moco-doc/plan.md) if you do not have any existing idea.

## Copyright and license
Copyright 2012-2026 ZHENG Ye

Licensed under MIT License (the "License"); You may obtain a copy of the License in [MIT-LICENSE.txt](MIT-LICENSE.txt), or at:

https://raw.github.com/dreamhead/moco/master/MIT-LICENSE.txt

## Powered By



## Star History

[](https://star-history.com/#dreamhead/moco&Date)

--- METRICS ---
- Files Extracted: 1
- Estimated Token Budget: ~776 tokens
- Recency Window: Active (< 180 days)
- Canonical Reference: https://codewiki.google/github.com/dreamhead/moco