GitHub

README

Welcome to the complete documentation for moclojer - a simple and efficient HTTP mock server. This documentation is designed to help you get started quickly and become proficient with all of moclojer's features.

🚀 Getting Started

New to moclojer? Start with our progressive tutorial series:

  1. Overview - Learn what moclojer is and why you'd want to use it

  2. Installation - Get moclojer running on your system

  3. Your First Mock Server - Create a working API in 10 minutes

  4. Dynamic Responses - Make your mocks respond to request data

  5. Multiple Endpoints - Build complete APIs with proper structure

  6. Real-World Example - Complete e-commerce API tutorial

📚 Documentation Structure

This documentation follows a progressive structure inspired by Django's excellent documentation:

🎯 First Steps

Perfect for beginners - get up and running quickly with guided tutorials.

🧠 Core Concepts

Understand how moclojer works with detailed explanations of key concepts:

  • Configuration - YAML, EDN, and OpenAPI formats

  • Endpoints - HTTP methods, paths, and responses

  • Templates - Dynamic content generation

  • Parameters - Path, query, body, and header handling

⚡ Advanced Features

Specialized functionality for complex scenarios:

  • WebSocket support

  • External bodies

  • Webhooks

  • Rate limiting

  • Multi-domain support

🔧 Framework Integration

Using moclojer as a library and integrating with applications:

  • Clojure integration

  • Testing workflows

  • Development practices

📖 Reference Documentation

Complete technical reference for all features:

  • Configuration specification

  • Template variables

  • CLI reference

  • FAQ and troubleshooting

🚀 Deployment & Operations

Production deployment and operational concerns:

  • Docker deployment

  • Cloud deployment

  • Monitoring and security

💡 Examples & Recipes

Practical examples and common patterns:

  • REST API mocking

  • Industry-specific examples

  • Integration examples

🎯 Learning Paths

I'm entirely new to moclojer

  1. Read the Overview

  2. Follow the Installation guide

  3. Complete all tutorials in the "First Steps" section

  4. Explore Core Concepts as needed

I want to mock a specific type of API

  1. Check Examples & Recipes for your use case

  2. Review relevant Core Concepts

  3. Refer to the Configuration Specification

I'm integrating moclojer into my application

  1. Read Using as a Library

  2. Check Testing Integration

  3. Review Development Workflows

I need help with a specific feature

  1. Check the FAQ first

  2. Search the Reference Documentation

  3. Look for examples in Examples & Recipes

🔍 Quick Reference

Common Tasks

Configuration Reference

Troubleshooting

🏃‍♂️ Running Documentation Locally

You can run this documentation locally using the included server:

# Navigate to the moclojer directory
cd moclojer

# Start the documentation server
node serve-docs.js

# Open http://localhost:3000 in your browser

The local server provides:

  • Full navigation

  • Search functionality

  • Mobile-responsive design

  • Fast loading

🤝 Contributing to Documentation

We welcome contributions to improve the documentation! Here's how you can help:

Quick Fixes

  • Fix typos or broken links

  • Improve unclear explanations

  • Add missing examples

Larger Contributions

  • Write new tutorials

  • Add industry-specific examples

  • Improve existing guides

  • Translate content

How to Contribute

  1. Fork the repository

  2. Make your changes in the docs/ directory

  3. Test locally using node serve-docs.js

  4. Submit a pull request

Writing Guidelines

  • Use clear, simple language - Write for developers of all skill levels

  • Include practical examples - Show, don't just tell

  • Follow the progressive structure - Start simple, add complexity gradually

  • Test all code examples - Ensure examples actually work

  • Use proper Markdown formatting - Follow existing style

📞 Getting Help

Community Resources

Documentation Issues

If you find problems with the documentation:

  1. Check if it's already reported in GitHub Issues

  2. Create a new issue with:

    • Clear description of the problem

    • Which page/section is affected

    • Suggested improvement (if applicable)

📄 Documentation License

This documentation is part of the moclojer project and follows the same MIT license as the main project.

Ready to get started? Begin with the Overview to learn what moclojer can do for you! 🚀

NextOverview

Last updated

Was this helpful?