ARMA, high performance, easy to learn, fast to code, ready for production

A Real Mock API

ARMA is a set of packages for API mocking and contract testing with OpenAPI v3.x.

ARMA provides:

• Mock Servers: Life-like mock servers from any API specification document.
• Validation Proxy: Contract Testing for API consumers and developers.
• Comprehensive API Specification Support: OpenAPI v3.1, OpenAPI v3.0.

Ways to Use ARMA

Self-hosted ARMA

ARMA is an open-source HTTP server run from the command-line. It provides mocking, request validation, and content negotiation. Use it standalone tool or in continuous integration.

Start Self-hosted ARMA

Update a_real_settings.json

{
 "mock_api_swaggerUrl": "https//www.apitomock.com/doc/swagger.json",
 "update_on_start": true,
}

ARMA requires

• Docker-Compose >= 2.29.1

make arma/start

---

Click here to Full Documentation

---

🏁 Help Others Utilize ARMA

If you're using ARMA for an interesting use case, contact us for a case study. We'll add it to a list here. Spread the goodness 🎉

👏 Contributing

If you are interested in contributing to ARMA itself, check out our contributing docs ⇗ and code of conduct ⇗ to get started.

🎉 Thanks

ARMA is built on top of lots of excellent packages, and here are a few we'd like to say a special thanks to.

• rocketry
• aiohttp
• jsonschema
• jsf
• ruamel-yaml
• fastapi

Check these projects out!

🌲 Sponsor ARMA by Planting a Tree

If you would like to thank us for creating ARMA, we ask that you buy the world a tree.