NodeJS Структура папок APIs - PullRequest
0 голосов
/ 07 января 2020

У меня будет несколько 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

Правильно ли то, что я делаю?

Если это неправильно, как правильно это сделать?

1 Ответ

1 голос
/ 08 января 2020

Это действительно зависит от ваших личных предпочтений.

Если вы предпочитаете иметь все функции в одном файле, это нормально. Хорошая вещь в этом заключается в том, что вам не нужно отслеживать необходимость других файлов.

Я думаю, вы должны подумать о том, как API связаны друг с другом, сколько у вас различных функций и длина функций. Если у вас мало функций, вам следует хранить их все в одном файле. Однако, если у вас есть много больших независимых API-интерфейсов, тогда их можно более организованно хранить в отдельных файлах.

В конце концов, нет правильного или неправильного ответа. Вы решаете, основываясь на своем стиле, и если вам нужны советы и мнения, в комментариях есть много. Удачи.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...