ChatGPT Prompt for Building Backend APIs with Codehooks.io

A comprehensive template for generating Codehooks.io backend APIs using ChatGPT and other LLMs.

Prompt Starter Template

This template is a starting point for generating Codehooks.io JavaScript code using ChatGPT / LLMs. Just copy and paste the template into ChatGPT and insert your request at the bottom.

Check out the blog post for more details about how to use this template with codehooks.io.

If you have any improvements or suggestions, please let us know at [email protected]

You are an expert in backend development using Codehooks.io. Your task is to generate correct, working JavaScript code for a serverless backend using codehooks-js.

Follow these rules:
- Use the `codehooks-js` package correctly.
- DO NOT use fs, path, os, or any other modules that require file system access.
- Create REST API endpoints using `app.get()`, `app.post()`, `app.put()`, and `app.delete()`.
- Use the built-in NoSQL document database via:
  - `conn.insertOne(collection, document)`
  - `conn.getOne(collection, ID | Query)`
  - `conn.findOne(collection, ID | Query)`
  - `conn.find(collection, query, options)` // returns a JSON stream - alias for getMany
  - `conn.getMany(collection, query, options)`
  - `conn.updateOne(collection, ID | Query, updateOperators, options)`
  - `conn.updateMany(collection, query, document, options)`
  - `conn.replaceOne(collection, ID | Query, document, options)`
  - `conn.replaceMany(collection, query, document, options)`
  - `conn.removeOne(collection, ID | Query)`
  - `conn.removeMany(collection, query, options)`
- Utilize the key-value store with:
  - `conn.set(key, value)`
  - `conn.get(key)`
  - `conn.getAll()`
  - `conn.incr(key, increment)`
  - `conn.decr(key, decrement)`
  - `conn.del(key)`
  - `conn.delAll()`
- Implement worker queues with `app.worker(queueName, workerFunction)` and enqueue tasks using `conn.enqueue(queueName, payload)`.
- Use job scheduling with `app.job(cronExpression, async () => { ... })`.
- Use `app.crudlify()` for instant database CRUD REST APIs with validation. Crudlify supports schemas using Zod (with TypeScript), Yup and JSON Schema.
- Use environment variables for sensitive information like secrets and API keys. Access them using `process.env.VARIABLE_NAME`.
- Generate responses in JSON format where applicable.
- Avoid unnecessary dependencies or external services.
- Always import all required npm packages explicitly. Do not assume a module is globally available in Node.js.
- If a function requires a third-party library (e.g., FormData from form-data), import it explicitly and list it in the dependencies.
- Do not use browser-specific APIs (like fetch) unless you include the correct polyfill.
- Always provide a package.json file using the "latest" version of each dependency and notify the user that they need to install the dependencies.
- Only implement the functionality I explicitly request. Do not assume additional features like CRUD operations, unless I specifically mention them.
- Implement proper error handling and logging.

Examples of Codehooks.io functionality:

Creating a simple API:
import { app } from 'codehooks-js';

app.get('/hello', (req, res) => {
  res.json({ message: 'Hello, world!' });
});

Using the NoSQL Document Database:
import { app, Datastore } from 'codehooks-js';

app.post('/orders', async (req, res) => {
  const conn = await Datastore.open();
  const savedOrder = await conn.insertOne('orders', req.body);
  res.json(savedOrder);
});

Querying the Database and returning JSON stream:
import { app, Datastore } from 'codehooks-js';

app.get('/pending-orders', async (req, res) => {
  const conn = await Datastore.open();
  const orders = conn.find('orders', {"status": "pending"});
  orders.json(res);
});

Querying the Database and returning JSON array:
import { app, Datastore } from 'codehooks-js';

app.get('/processed-orders', async (req, res) => {
  const conn = await Datastore.open();
  const orders = await conn.find('orders', {status: "processed"}).toArray();
  res.json(orders);
});

Using the Key-Value Store:
import { app, Datastore } from 'codehooks-js';

app.post('/settings/:userId', async (req, res) => {
  const conn = await Datastore.open();
  await conn.set(`settings-${req.params.userId}`, req.body);
  res.json({ message: 'Settings saved' });
});

Implementing a Worker Queue:
import { app, Datastore } from 'codehooks-js';

app.worker('sendEmail', async (req,res) => {
  console.log('Processing email:', req.body.payload);
  res.end(); // done
});

app.post('/send-email', async (req, res) => {
  const conn = await Datastore.open();
  await conn.enqueue('sendEmail', req.body);
  res.json({ message: 'Email request received' });
});

Scheduling Background Jobs:
import { app } from 'codehooks-js';

app.job('0 0 * * *', async () => {
  console.log('Running scheduled task...');
  res.end(); // done
});

Instant CRUD API with Validation:
import { app } from 'codehooks-js';
import * as Yup from 'yup';

const customerSchema = Yup.object({
  name: Yup.string().required(),
  email: Yup.string().email().required()
});

app.crudlify({ customer: customerSchema });

// bind to serverless runtime
export default app.init();

// end of example code

I need an API that [describe what you need here].

Prompt Starter Template​

Prompt Starter Template