statapi

███████╗████████╗ █████╗ ████████╗ █████╗ ██████╗ ██╗
██╔════╝╚══██╔══╝██╔══██╗╚══██╔══╝██╔══██╗██╔══██╗██║
███████╗   ██║   ███████║   ██║   ███████║██████╔╝██║
╚════██║   ██║   ██╔══██║   ██║   ██╔══██║██╔═══╝ ██║
███████║   ██║   ██║  ██║   ██║   ██║  ██║██║     ██║
╚══════╝   ╚═╝   ╚═╝  ╚═╝   ╚═╝   ╚═╝  ╚═╝╚═╝     ╚═╝

Statapi

Statapi is a simple tool designed to generate static JSON files for your projects. It provides a flexible way to create JSON files, which can be used for static site generation, API mockups, or any other scenario where pre-generated JSON data is needed.

Table of Contents

• Installation
• Usage
• Directory Structure
• Generating JSON Files
  • 1. Static JSON Files
  • 2. Dynamic JSON Files from JavaScript
  • 3. Dynamic Routes
• Scripts
  • Development
  • Production Build
• Yarn Support

Installation

First, install the statapi package as a development dependency in your project:

Using npm:

npm install statapi --save-dev

Using Yarn:

yarn add statapi --dev

Usage

Once installed, you can use the statapi commands to generate your JSON files. These commands can be added to your package.json scripts for ease of use.

Directory Structure

Your project should follow this basic directory structure:

project-root/
│
├── src/
│   └── apis/
│       ├── demo/
│       │   └── demo.json
│       ├── users/
│       │   └── [userId].js
│       └── data.js
│
├── dist/
│   └── (Generated JSON files will be placed here)
│
├── package.json
└── ...

• src/apis/: This is where you place your source files. These files will be processed and converted to JSON files.
• dist/: The generated JSON files will be placed here, mirroring the structure of src/apis/.

Generating JSON Files

There are three ways to generate JSON files with statapi:

1. Static JSON Files

You can simply place .json files in the src/apis/ directory. These files will be copied directly to the dist/ directory, maintaining the directory structure.

2. Dynamic JSON Files from JavaScript

You can also create .js files that export a function. The return value of this function will be saved as a JSON file in the corresponding location in the dist/ directory.

3. Dynamic Routes

For more dynamic use cases, you can create files with a dynamic segment in their name (e.g., [userId].js). These files should export two functions:

• Default Function: Generates the JSON data based on the parameters passed.
• getPaths Function: Returns an array of paths (parameters) for which the JSON files should be generated.

Scripts

Add the following scripts to your package.json to streamline development and production builds:

{
  "scripts": {
    "start": "statapi start",
    "build": "statapi build"
  }
}

Development

During development, run the following command:

Using npm:

npm run start

Using Yarn:

yarn start

This will start the statapi in watch mode, where it watches for changes in the src/apis/ directory and regenerates the JSON files automatically.

Production Build

For a production build, use:

Using npm:

npm run build

Using Yarn:

yarn build

This command will generate all the JSON files and place them in the dist/ directory, ready for deployment.

Yarn Support

If you prefer using Yarn, all the commands provided for npm can be executed with Yarn as well. Simply replace npm run with yarn followed by the script name. For example:

• Development: yarn start
• Production Build: yarn build

Yarn provides a faster, more secure alternative to npm, and is fully supported by statapi.