go-mock

README

GoMock

A lightweight, file-based JSON REST API server for mocking and prototyping.

Features

• Simple file-based data storage
• RESTful CRUD operations
• Zero-configuration setup
• Lightweight and fast
• Supports multiple collections

Installation

# Install via go get
go install github.com/AaronDennis07/go-mock@latest

# Or clone and build
git clone https://github.com/AaronDennis07/go-mock.git
cd go-mock
go build

Quick Start

1. Create a db.json file:

{
  "posts": [
    {"id": 1, "title": "First Post"}
  ],
  "users": [
    {"id": 1, "name": "Aaron Dennis"}
  ]
}

1. Run the server using an absolute file path:

# Windows Example
go-mock -db="C:\full\path\to\your\db.json" -port=3000

# macOS/Linux Example
go-mock -db="/full/path/to/your/db.json" -port=3000

Important:

• Always use the full, absolute path to your db.json file
• Enclose the path in quotes if it contains spaces
• Use backslashes (\) for Windows paths
• Use forward slashes (/) for macOS/Linux paths

Usage

Command-line Flags

• -db: Full path to JSON database file (required)
• -port: Server port (default: 3000)

API Endpoints

• GET /{collection}: List all items
• GET /{collection}/{id}: Get specific item
• POST /{collection}: Create new item
• PUT /{collection}/{id}: Update existing item
• DELETE /{collection}/{id}: Delete item

Examples

# Get all posts
curl http://localhost:3000/posts

# Create a new post
curl -X POST http://localhost:3000/posts \
    -H "Content-Type: application/json" \
    -d '{"title":"New Post"}'

# Update a post
curl -X PUT http://localhost:3000/posts/1 \
    -H "Content-Type: application/json" \
    -d '{"title":"Updated Post"}'

# Delete a post
curl -X DELETE http://localhost:3000/posts/1

Contributing

1. Fork the repository
2. Create your feature branch
3. Commit changes
4. Push to the branch
5. Create a Pull Request

License

MIT License

Documentation

Overview

main starts the gomock server and logs any fatal errors during startup.