https://github.com/dreamhead/moco

Easy Setup Stub Server
https://github.com/dreamhead/moco

Last synced: 3 days ago
JSON representation

Easy Setup Stub Server

• Host: GitHub
• URL: https://github.com/dreamhead/moco
• Owner: dreamhead
• License: mit
• Created: 2012-10-18T09:09:51.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2024-07-24T15:21:30.000Z (5 months ago)
• Last Synced: 2024-12-02T20:07:04.274Z (10 days ago)
• Language: Java
• Homepage:
• Size: 5.8 MB
• Stars: 4,379
• Watchers: 274
• Forks: 1,084
• Open Issues: 142
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE.txt

Awesome Lists containing this project

• awesome-hacking-lists - dreamhead/moco - Easy Setup Stub Server (Java)

README

        




  



# [Moco](https://github.com/dreamhead/moco) 

[![Build](https://github.com/dreamhead/moco/actions/workflows/build.yaml/badge.svg)](https://github.com/dreamhead/moco/actions/workflows/build.yaml)

[![HitCount](http://hits.dwyl.com/dreamhead/moco.svg?style=flat-square)](http://hits.dwyl.com/dreamhead/moco)

Moco is an easy setup stub framework.

## Latest Release

* [![Maven Central](https://img.shields.io/maven-central/v/com.github.dreamhead/moco-core.svg?label=Maven%20Central)](https://central.sonatype.com/artifact/com.github.dreamhead/moco-core)

* [Release Notes](moco-doc/ReleaseNotes.md)

## 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.5.0/moco-runner-1.5.0-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--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) or [Socket APIs](moco-doc/socket-apis.md)

* Detailed [REST API](moco-doc/rest-apis.md)

* Detailed [Websocket API](moco-doc/websocket-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

Make sure you have JDK and Gradle installed.

* Clone Moco

```shell

git clone [email protected]: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-2023 ZHENG Ye

Licensed under MIT License (the "License"); You may obtain a copy of the License in the LICENSE file, or at:

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

## Powered By



## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=dreamhead/moco&type=Date)](https://star-history.com/#dreamhead/moco&Date)