FauxREST

⚓️ Install

Tue, 30 Jun 2026 00:00:00 +0000

Prerequisites
#

Rust toolchain (cargo) installed.

Build From Source
#

git clone https://github.com/username/fauxrest.git
cd fauxrest
cargo build --release

The binary is generated at target/release/fauxrest.

Quick Start
#

Create a data/ directory with JSON files.
Prepare a config file (for example fauxrest.json) if you need explicit serializer/layout settings.
Build outputs:

fauxrest build ./data fauxrest.json

Check generated files under the configured destination path.

Example Input
#

{
	"name": "Alice",
	"role": "Developer"
}

⚙️ Configuration

Tue, 30 Jun 2026 00:00:00 +0000

Configuration Tiers
#

fauxrest supports three tiers depending on required control:

Zero-config: infer endpoints from ./data structure.
Convention overlay: patch inferred tree via _config.json style files.

Auto-discovery for config files checks:

_config.json
_fauxrest.json
.config.json
.fauxrest.json

Serializer Configuration
#

Set serializers under $config.serializers.

{
	"$config": {
		"serializers": [
			{ "serializer": "json", "layout": "index", "dest": "./dist/api" },
			{ "serializer": "typescript", "layout": "file", "dest": "./dist/modules" },
			{ "serializer": "sqlite", "dest": "./dist/db/api.db" }
		]
	}
}

Supported serializers:

⭐️ Features

Tue, 30 Jun 2026 00:00:00 +0000

Data Transformation
#

Filtering
#

$filter supports structured conditions with field, op, and value.

Supported operators:

eq, neq
gt, gte, lt, lte
contains
exists
regeq, regneq

Child $filter overrides parent $filter when both are present.

Sanitization
#

$pick: keep only selected fields.
$omit: remove selected fields.

Visibility Control
#

$private: true suppresses generation of the target endpoint and all descendants.

🏃 Usage

Tue, 30 Jun 2026 00:00:00 +0000

fauxrest provides a small command surface for build and local verification workflows.

How to run `fauxrest`
#

A CLI tool for generating static JSON APIs from local data files

Usage: fauxrest [OPTIONS] <DATA_DIR>

Arguments:
  <DATA_DIR>  Path to the input data directory

Options:
  -L, --level <LEVEL>            Specify the log level [default: warn] [possible values: error, warn, info, debug, trace]
  -c, --config <CONFIG_FILE>     Path to the configuration file
  -l, --layout <LAYOUT>          Layout to use for the output [possible values: index, file, extension]
  -d, --dest <DEST_DIR>          Path to the output directory [default: dist]
  -s, --serializer <SERIALIZER>  Serializer to use for the output. [available: json, typescript, sql] [default: json]
      --minify                   If true, minify the output
  -h, --help                     Print help (see more with '--help')
  -V, --version                  Print version

Build psuede REST data
#

Compile datasets into static outputs.

👩‍💻 How to contribute 🧑‍💻

Tue, 30 Jun 2026 00:00:00 +0000

Crate Architecture
#

fauxrest separates core logic from CLI orchestration.

Library crate: implemented in src/lib.rs.
Binary crate: implemented in src/cmd/main.rs.

Dependency rule:

CLI code may depend on library code.
Library code must not depend on CLI modules.

Programmatic Use
#

Use the library crate when embedding fauxrest behavior in tooling or internal pipelines. Keep command parsing and process-level concerns outside library boundaries.

💃 Developers

Tue, 30 Jun 2026 00:00:00 +0000

This documents show how to use fauxrest as a user.

😀 About

Tue, 30 Jun 2026 00:00:00 +0000

👩‍💼 Developers 👨‍💼
#

Haruaki Tamada (@tamada)
Google Gemini, GitHub Copilot

📄 License
#

This project is licensed under the MIT License. See LICENSE for details.

📛 The project name (`fauxrest`)
#

The project name fauxrest is pronounced /fɔːrɪst/ or /foʊrɪst/, which is the same as “forest”. And it is derived from Faux (meaning `fake’ in French) and REST.

🚶 API Examples

Tue, 30 Jun 2026 00:00:00 +0000

🕺 Developers

Tue, 30 Jun 2026 00:00:00 +0000

These documents describe how to use fauxrest as a developer.

FauxREST

⚓️ Install

Prerequisites #

Build From Source #

Quick Start #

Example Input #

⚙️ Configuration

Configuration Tiers #

Serializer Configuration #

⭐️ Features

Data Transformation #

Filtering #

Sanitization #

Visibility Control #

🏃 Usage

How to run fauxrest #

Build psuede REST data #

👩‍💻 How to contribute 🧑‍💻

Crate Architecture #

Programmatic Use #

💃 Developers

😀 About

👩‍💼 Developers 👨‍💼 #

📄 License #

📛 The project name (fauxrest) #

🚶 API Examples

🕺 Developers

Prerequisites
#

Build From Source
#

Quick Start
#

Example Input
#

Configuration Tiers
#

Serializer Configuration
#

Data Transformation
#

Filtering
#

Sanitization
#

Visibility Control
#

How to run `fauxrest`
#

Build psuede REST data
#

Crate Architecture
#

Programmatic Use
#

👩‍💼 Developers 👨‍💼
#

📄 License
#

📛 The project name (`fauxrest`)
#