README
Last updated
Was this helpful?
Last updated
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.
New to moclojer? Start with our progressive tutorial series:
- Learn what moclojer is and why you'd want to use it
- Get moclojer running on your system
- Create a working API in 10 minutes
- Make your mocks respond to request data
- Build complete APIs with proper structure
- Complete e-commerce API tutorial
This documentation follows a progressive structure inspired by Django's excellent documentation:
Perfect for beginners - get up and running quickly with guided tutorials.
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
Specialized functionality for complex scenarios:
WebSocket support
External bodies
Webhooks
Rate limiting
Multi-domain support
Using moclojer as a library and integrating with applications:
Clojure integration
Testing workflows
Development practices
Complete technical reference for all features:
Configuration specification
Template variables
CLI reference
FAQ and troubleshooting
Production deployment and operational concerns:
Docker deployment
Cloud deployment
Monitoring and security
Practical examples and common patterns:
REST API mocking
Industry-specific examples
Integration examples
Complete all tutorials in the "First Steps" section
You can run this documentation locally using the included server:
The local server provides:
Full navigation
Search functionality
Mobile-responsive design
Fast loading
We welcome contributions to improve the documentation! Here's how you can help:
Fix typos or broken links
Improve unclear explanations
Add missing examples
Write new tutorials
Add industry-specific examples
Improve existing guides
Translate content
Fork the repository
Make your changes in the docs/ directory
Test locally using node serve-docs.js
Submit a pull request
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
If you find problems with the documentation:
Create a new issue with:
Clear description of the problem
Which page/section is affected
Suggested improvement (if applicable)
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! 🚀