moclojer
GitHub
  • README
  • First Steps
    • Overview
    • Installation
    • Your First Mock Server
    • Dynamic Responses
    • Multiple Endpoints
    • Real-World Example
  • Templates
    • Template System Overview
    • Template Variables
  • Advanced Features
    • WebSocket Support
    • External Bodies
    • Webhook Integration
    • Rate Limiting
    • Multi-Domain Support
  • Framework Integration
    • Using as a Library
  • Reference Documentation
    • Configuration Specification
    • FAQ
  • Community and Contribution
    • Documentation Refactor
    • Code of Conduct
  • Release Notes
    • Latest Changes
    • v0.4.0
    • v0.3.5
    • v0.3.4
    • v0.3.3.1
    • v0.3.3
    • v0.3.2
    • v0.3.1
    • v0.3.0
    • v0.2
    • v0.1
Powered by GitBook
On this page
  • 🚀 Getting Started
  • 📚 Documentation Structure
  • 🎯 First Steps
  • 🧠 Core Concepts
  • ⚡ Advanced Features
  • 🔧 Framework Integration
  • 📖 Reference Documentation
  • 🚀 Deployment & Operations
  • 💡 Examples & Recipes
  • 🎯 Learning Paths
  • I'm entirely new to moclojer
  • I want to mock a specific type of API
  • I'm integrating moclojer into my application
  • I need help with a specific feature
  • 🔍 Quick Reference
  • Common Tasks
  • Configuration Reference
  • Troubleshooting
  • 🏃‍♂️ Running Documentation Locally
  • 🤝 Contributing to Documentation
  • Quick Fixes
  • Larger Contributions
  • How to Contribute
  • Writing Guidelines
  • 📞 Getting Help
  • Community Resources
  • Documentation Issues
  • 📄 Documentation License

Was this helpful?

Edit on GitHub

README

NextOverview

Last updated 13 days ago

Was this helpful?

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. - Learn what moclojer is and why you'd want to use it

  2. - Get moclojer running on your system

  3. - Create a working API in 10 minutes

  4. - Make your mocks respond to request data

  5. - Build complete APIs with proper structure

  6. - 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. Complete all tutorials in the "First Steps" section

I want to mock a specific type of API

I'm integrating moclojer into my application

I need help with a specific feature

🔍 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. 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.


Read the

Follow the guide

Explore as needed

Check for your use case

Review relevant

Refer to the

Read

Check

Review

Check the first

Search the

Look for examples in

Create your first mock:

Use path parameters:

Handle JSON data:

Mock WebSockets:

Load external data:

All template variables:

Complete YAML specification:

CLI options:

Common issues:

Detailed troubleshooting:

- Ask questions and share ideas

- Report bugs or request features

Check if it's already reported in

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

Overview
Installation
Your First Mock Server
Dynamic Responses
Multiple Endpoints
Real-World Example
Overview
Installation
Core Concepts
Examples & Recipes
Core Concepts
Configuration Specification
Using as a Library
Testing Integration
Development Workflows
FAQ
Reference Documentation
Examples & Recipes
Your First Mock Server
WebSocket Support
External Bodies
Template Variables Reference
Configuration Specification
CLI Reference
FAQ
Troubleshooting Guide
GitHub Discussions
GitHub Issues
GitHub Issues
Overview
Dynamic Responses
Template Variables