🗄️ JsonDB API

A document database API built for Val Town

\n \n

Quick Start

\n# Create a document\ncurl -X POST ${c.req.url}collections/users/documents \\\\\n -H \"Content-Type: application/json\" \\\\\n -d '{\"name\": \"John Doe\", \"email\": \"john@example.com\", \"age\": 30}'\n\n# Get all documents\ncurl ${c.req.url}collections/users/documents\n\n# Get document by ID\ncurl ${c.req.url}collections/users/documents/{id}\n\n# Update document\ncurl -X PUT ${c.req.url}collections/users/documents/{id} \\\\\n -H \"Content-Type: application/json\" \\\\\n -d '{\"age\": 31}'\n\n# Delete document\ncurl -X DELETE ${c.req.url}collections/users/documents/{id}\n

\n\n

API Endpoints

\n GET /health - Health check\n

\n GET /stats - Database statistics\n

\n GET /collections - List collections\n

\n POST /collections - Create collection\n

\n GET /collections/{name}/documents - Find documents\n

\n POST /collections/{name}/documents - Create document\n

\n GET /collections/{name}/documents/{id} - Get document\n

\n PUT /collections/{name}/documents/{id} - Update document\n

\n DELETE /collections/{name}/documents/{id} - Delete document\n

\n\n

Query Parameters

limit - Number of documents to return
offset - Number of documents to skip
sort - JSON array: [{\"field\": \"name\", \"direction\": \"asc\"}]
where - JSON object: {\"field\": \"value\"}

\n\n

Example Usage

\n# Find users over 25, sorted by name\ncurl \"${c.req.url}collections/users/documents?where=%7B%22age%22:%7B%22$gte%22:25%7D%7D&sort=%5B%7B%22field%22:%22name%22,%22direction%22:%22asc%22%7D%5D\"\n\n# Paginate results\ncurl \"${c.req.url}collections/users/documents?limit=10&offset=20\"\n

\n\n`;\n \n return c.html(html);\n});\n\n// Health check\napp.get('/health', (c) => {\n return c.json({ \n status: 'ok', \n timestamp: new Date().toISOString(),\n service: 'JsonDB API'\n });\n});\n\n// Database stats\napp.get('/stats', async (c) => {\n try {\n const stats = await jsonDb.getStats();\n return c.json(stats);\n } catch (error) {\n return c.json({ error: 'Failed to get stats' }, 500);\n }\n});\n\n// List collections\napp.get('/collections', async (c) => {\n try {\n const collections = await jsonDb.listCollections();\n return c.json({ collections });\n } catch (error) {\n return c.json({ error: 'Failed to list collections' }, 500);\n }\n});\n\n// Create collection\napp.post('/collections', async (c) => {\n try {\n const { name } = c.get('body') || {};\n if (!name) {\n return c.json({ error: 'Collection name required' }, 400);\n }\n\n const success = await jsonDb.createCollection(name);\n if (success) {\n return c.json({ message: `Collection '${name}' created` });\n } else {\n return c.json({ error: 'Failed to create collection' }, 500);\n }\n } catch (error) {\n return c.json({ error: 'Failed to create collection' }, 500);\n }\n});\n\n// Get documents\napp.get('/collections/:name/documents', async (c) => {\n try {\n const collection = c.req.param('name');\n const limit = c.req.query('limit');\n const offset = c.req.query('offset');\n const sort = c.req.query('sort');\n const where = c.req.query('where');\n\n const options: any = {};\n if (limit) options.limit = parseInt(limit);\n if (offset) options.offset = parseInt(offset);\n if (sort) {\n try {\n options.sort = JSON.parse(sort);\n } catch (error) {\n return c.json({ error: 'Invalid sort parameter' }, 400);\n }\n }\n if (where) {\n try {\n options.where = JSON.parse(where);\n } catch (error) {\n return c.json({ error: 'Invalid where parameter' }, 400);\n }\n }\n\n const documents = await jsonDb.find(collection, options);\n return c.json({ documents });\n } catch (error) {\n return c.json({ error: 'Failed to find documents' }, 500);\n }\n});\n\n// Create document\napp.post('/collections/:name/documents', async (c) => {\n try {\n const collection = c.req.param('name');\n const document = c.get('body');\n \n if (!document) {\n return c.json({ error: 'Document data required' }, 400);\n }\n\n const result = await jsonDb.insert(collection, document);\n \n if (result.success) {\n return c.json({ \n message: 'Document created',\n id: result.id \n }, 201);\n } else {\n return c.json({ error: 'Failed to create document' }, 500);\n }\n } catch (error) {\n return c.json({ error: 'Failed to create document' }, 500);\n }\n});\n\n// Get document by ID\napp.get('/collections/:name/documents/:id', async (c) => {\n try {\n const collection = c.req.param('name');\n const id = c.req.param('id');\n \n const document = await jsonDb.findById(collection, id);\n \n if (document) {\n return c.json({ document });\n } else {\n return c.json({ error: 'Document not found' }, 404);\n }\n } catch (error) {\n return c.json({ error: 'Failed to find document' }, 500);\n }\n});\n\n// Update document\napp.put('/collections/:name/documents/:id', async (c) => {\n try {\n const collection = c.req.param('name');\n const id = c.req.param('id');\n const update = c.get('body');\n \n if (!update) {\n return c.json({ error: 'Update data required' }, 400);\n }\n\n const result = await jsonDb.updateById(collection, id, update);\n \n if (result.success) {\n return c.json({ \n message: 'Document updated',\n modifiedCount: result.modifiedCount \n });\n } else {\n return c.json({ error: 'Failed to update document' }, 500);\n }\n } catch (error) {\n return c.json({ error: 'Failed to update document' }, 500);\n }\n});\n\n// Delete document\napp.delete('/collections/:name/documents/:id', async (c) => {\n try {\n const collection = c.req.param('name');\n const id = c.req.param('id');\n \n const result = await jsonDb.deleteById(collection, id);\n \n if (result.success) {\n return c.json({ \n message: 'Document deleted',\n deletedCount: result.deletedCount \n });\n } else {\n return c.json({ error: 'Failed to delete document' }, 500);\n }\n } catch (error) {\n return c.json({ error: 'Failed to delete document' }, 500);\n }\n});\n\n// This is the entry point for HTTP vals\nexport default app.fetch;\n\n","deleted","label",[167,149],"examples","permalink","https://www.val.town/x/wilhelm/json-db/code/examples/simple-http.val.ts","extension","actionData","errors"]