mfdoc/build/src/genHttpApiTableOfContent.js

Auto generate JS SDK and HTTP API documentation

import fse from 'fs-extra';
import { forEach } from 'lodash-es';
import { getEndpointsFromSrcPath } from './getEndpointsFromSrcPath.js';
import { filterEndpointsByTags } from './utils.js';
function generateTableOfContentFromMfdoc(params) {
    const { endpoints, tags } = params;
    const tableOfContent = [];
    const pickedEndpoints = filterEndpointsByTags(endpoints, tags);
    forEach(pickedEndpoints, e1 => {
        tableOfContent.push([e1.name, e1.method]);
    });
    return tableOfContent;
}
export async function genHttpApiTableOfContent(params) {
    const { endpoints, tags, outputPath } = params;
    const tableOfContent = generateTableOfContentFromMfdoc({
        endpoints,
        tags,
    });
    await fse.ensureFile(outputPath);
    return fse.writeFile(outputPath, JSON.stringify(tableOfContent, /** replacer */ undefined, /** space */ 4), { encoding: 'utf-8' });
}
export async function genHttpApiTableOfContentCmd(params) {
    const { srcPath, tags, outputPath } = params;
    const endpoints = await getEndpointsFromSrcPath({ srcPath });
    await genHttpApiTableOfContent({ endpoints, tags, outputPath });
}
//# sourceMappingURL=genHttpApiTableOfContent.js.map