时间戳

首页 > 解决方案 > NodeJS APIs 文件夹结构

javascript - NodeJS APIs 文件夹结构

问题描述

我将在路由文件夹中有多个 API，我应该将它们放在同一个文件 API 中还是将它们分开？

├── app.js
├── src/
│   ├── contants/
│   ├── helpers/
│   ├── models/
│   ├── routes/
|   |         |___index.js
              |___api.js
│   └── libs/
│       ├── backbone/
│       ├── underscore/
│       └── ...

api.js file contains all the APIs
    const jwt = require("jsonwebtoken")
    const axios = require("axios")
    require("express-async-errors")
    const bodyParser = require("body-parser")
    const fs = require("fs")

    const LOLTrackingSystem = require("../methods/onlineGamesTracking/LOLTracking")
    const getUserData = require("../methods/leagueOfLegends/getUserData")
    const isAuthenticated = require("../helpers/authenticated")

    const apiRoute = (api) => {
      api.use(bodyParser.json())
      api.use(bodyParser.urlencoded({
        extended: false
      }));

      api.post("/api/auth", (req, res) => {
        //API Functions
      })

      api.post("/api/gizmo/memberProfile", isAuthenticated, (req, res) => {
        //API Functions
      })

      api.post("/api/gizmo/memberState/:userId/:host/:state", async (req, res) => {
        //API Functions
      })
    }

    module.exports = apiRoute

我做的对吗？

如果它是错误的，那么正确的方法是什么？

标签： javascriptnode.jsexpress

解决方案

这真的取决于你的个人喜好。

如果您更喜欢将所有功能放在一个文件中，那也没关系。这样做的一个好处是您不必跟踪需要其他文件。

我认为你应该考虑的是 API 之间的相关性，你有多少不同的函数，以及函数的长度。如果您没有很多功能，那么您应该将它们全部保存在一个文件中。但是，如果您有许多大的、独立的 api，则可以更有条理地将它们保存在单独的文件中。

最后，没有正确或错误的答案。您根据自己的风格做出决定，如果您需要建议和意见，评论中会有很多。祝你好运。

推荐阅读