mirror of
https://github.com/Shineii86/AniKotoAPI.git
synced 2026-10-22 10:55:10 +00:00
v1.5.0: Complete documentation rewrite - 50+ files with AlisaReactionBot style
- Box-style header comments (Project, Author, License) on every file - Section headers using double-line box decorators - Feature markers (// ---- FEATURE: XYZ ----) before every major function - JSDoc comments for EVERY function with @param, @returns, @example - Inline notes (NOTE, WARNING, TIP) for non-obvious logic - Footer END markers on every module - Matched code style to AlisaReactionBot repository - All files now searchable by feature name via grep Author: Shinei Nouzen <157171073+Shineii86@users.noreply.github.com>
This commit is contained in:
@@ -1,6 +1,41 @@
|
||||
/*
|
||||
* ======= • ======= • ======= • ======= • =======• =======
|
||||
* AniKatoAPI — topten.controller.js
|
||||
* Repository: https://github.com/Shineii86/AniKatoAPI
|
||||
*
|
||||
* @description
|
||||
* Controller for top 10 ranked anime. Returns the current top 10
|
||||
* anime list from the source site. No parameters required.
|
||||
*
|
||||
* @exports
|
||||
* getTopTen - Express route handler for GET /api/top-ten
|
||||
*
|
||||
* @author Shinei Nouzen
|
||||
* @license MIT
|
||||
* ======= • ======= • ======= • ======= • =======• =======
|
||||
*/
|
||||
|
||||
import { extractTopTen } from "../extractors/topten.extractor.js";
|
||||
import { getCache, setCache } from "../helper/cache.helper.js";
|
||||
|
||||
// ══════════════════════════════════════════════════════════════
|
||||
// CONTROLLER: TOP TEN
|
||||
// ══════════════════════════════════════════════════════════════
|
||||
|
||||
// ---- FEATURE: Top 10 anime endpoint ----
|
||||
/**
|
||||
* Handles GET /api/top-ten requests. Returns the current top 10
|
||||
* ranked anime from the source site.
|
||||
*
|
||||
* @param {object} req - Express request object
|
||||
* @param {object} res - Express response object
|
||||
* @param {Function} next - Express next middleware function
|
||||
* @returns {void} Sends JSON response with top 10 anime list
|
||||
*
|
||||
* @example
|
||||
* GET /api/top-ten
|
||||
* Response: { success: true, results: [{ rank, title, ... }] }
|
||||
*/
|
||||
const getTopTen = async (req, res, next) => {
|
||||
try {
|
||||
const cacheKey = "topTen";
|
||||
@@ -8,7 +43,6 @@ const getTopTen = async (req, res, next) => {
|
||||
if (cached) {
|
||||
return res.json({ success: true, results: cached });
|
||||
}
|
||||
|
||||
const data = await extractTopTen();
|
||||
setCache(cacheKey, data);
|
||||
res.json({ success: true, results: data });
|
||||
@@ -17,4 +51,6 @@ const getTopTen = async (req, res, next) => {
|
||||
}
|
||||
};
|
||||
|
||||
export { getTopTen };
|
||||
export { getTopTen };
|
||||
|
||||
// ══════════════════════════════════════════════════════════════ END: topten.controller.js
|
||||
Reference in New Issue
Block a user