Automattic / Automattic/kue

Proposal: Expose JSON API Routes

Open
#1,142 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
9.4k
Forks
858
PR merge metrics
No merged PRs in 30d

Description

## Reason
In some circumstances someone might need to use the available JSON API Routes without needing to mount the entire Express App instance through a middleware or from a standalone Kue instance.

## Proposal
Expose the JSON API Routes, so it could be used as:
`const kueJsonRoutes = require('kue').json`
or through the App instance
`const kueJsonRoutes = require('kue').app.json`

Will like to know what others thoughts are on integrating this. I can open a PR for changes if accepted.

Thanks!

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating how Kue currently mounts its JSON API routes through the Express app. Compare the proposed require('kue').json and require('kue').app.json entry points, then review the surrounding issue discussion for an accepted integration direction. Done means the routes are independently exposed without requiring the full Express app, with the public API and usage agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
express, javascript, node.js
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.