📦
Hippie
a hyper media api framework
0 installs
Trust: 34 — Low
Content
Ask AI about Hippie
Powered by Claude · Grounded in docs
I know everything about Hippie. Ask me about installation, configuration, usage, or troubleshooting.
0/500
Loading tools...
Reviews
Documentation
Hippie 3.0
A modern mock + hypermedia API server with streaming (Socket.IO) and MCP support.
Highlights
- File-based HTTP mocks (legacy
mocks/GET__#path@q=value.jsonand newmocks/get/path.jsonstyles) - Socket.IO streaming mocks (
/streamnamespace) - MCP stdio server backed by mock tool definitions
- Handy admin endpoints (
/health,/__mocks)
Quick Start
npm install
npm run dev
Server runs at http://localhost:3000 by default.
Tests
npm test
npm run test:coverage
HTTP Mocking
Place JSON files in mocks/ and the server will resolve requests to the matching mock file.
Supported filename styles:
- Legacy:
GET__#book@id=123.jsonmaps toGET /book?id=123 - Legacy path segments:
GET__#t#101.jsonmaps toGET /t/101 - Modern:
mocks/get/book.jsonmaps toGET /book - Fallback:
mocks/_fallback.json
Mock Metadata
Wrap metadata in __meta to control status, headers, or delay.
{
"__meta": {
"status": 201,
"delayMs": 250,
"headers": {
"x-mock": "true"
}
},
"id": 123,
"message": "created"
}
Streaming (Socket.IO)
Connect to the /stream namespace. Use subscribe with a topic matching a file in mocks/streams.
Example client flow:
- Emit
subscribewith{ "topic": "heartbeat" } - Receive
eventpayloads defined inmocks/streams/heartbeat.json
To allow publishing from clients or HTTP:
ALLOW_STREAM_PUBLISH=1 npm run dev
MCP (Model Context Protocol)
Run the MCP server over stdio:
npm run mcp
- Tool definitions live in
mocks/mcp/tools/*.json - Tool responses live in
mocks/mcp/responses/<tool>.json
Admin Endpoints
GET /healthGET /__mocksGET /__openapiPOST /__stream/:topic(requiresALLOW_STREAM_PUBLISH=1)
License
The MIT license.
