Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (start-fapi) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
FAPI (Fake API)
A developer tool for creating and simulating fake APIs (FAPIs) locally for rapid and independent frontend development.
Features
- Create mock API endpoints dynamically
- Support for following HTTP methods (GET, POST, PUT, DELETE)
- Custom response delays
- JSON response configuration
- Multiple instance support (run on different ports)
- Interactive UI for managing FAPI endpoints
Installation & Usage
Run FAPI directly with npx (no installation required):
# Start on default port 3000
npx start-fapi
# Start on custom port
npx start-fapi --port 4000
npx start-fapi -p 5000Running Multiple Instances
You can run multiple instances of FAPI on different ports to maintain separate API configurations:
# Terminal 1
npx start-fapi --port 3000
# Terminal 2
npx start-fapi --port 3001
# Terminal 3
npx start-fapi --port 3002Each instance will have its own storage in the .fapi-storage folder.
How It Works
- Run the command
npx start-fapi - Open your browser at
http://localhost:3000 - Create fake API endpoints through the UI
- Your endpoints are immediately available at
http://localhost:3000/api/fapi/your-endpoint - All configurations are stored locally in
.fapi-storage
Example
If you create an endpoint named /users, it will be accessible at:
http://localhost:3000/api/fapi/usersUse Cases
- Frontend development without waiting for backend teams to complete building APIs
- Testing frontend applications by simulating API behaviors with various responses, response status codes and delays
- Creating demo applications with mock data
- API prototyping and experimentation
- Learning and teaching REST API concepts
Requirements
- Node.js >= 18.0.0
License
MIT