18

我正在使用 NodeJS (Mongoose & ExpressJS) 构建一个 REST API。我认为我目前有一个很好的基本结构，但我想知道这种项目的最佳实践是什么。

在这个基本版本中，一切都通过app.js文件。然后将每个 HTTP 方法传递给已请求的资源。这使我可以动态地向 API 添加资源，并且每个请求都将相应地传递。为了显示：

// app.js

var express = require('express');
var mongoose = require('mongoose');

var app = express();
app.use(express.bodyParser());

mongoose.connect('mongodb://localhost/kittens');
var db = mongoose.connection;

var resources = [
  'kitten'
];

var repositories = {};

for (var i = 0; i < resources.length; i++) {
  var resource = resources[i];
  repositories[resource] = require('./api/' + resource);
}

db.on('error', console.error.bind(console, 'connection error:'));
db.once('open', function callback() {
  console.log('Successfully connected to MongoDB.');

  app.get('/:resource', function (req, res) {
    res.type('application/json');
    repositories[req.params.resource].findAll(res);
  });

  app.get('/:resource/:id', function (req, res) {
    res.type('application/json');
    repositories[req.params.resource].findOne(req, res);
  });

  app.listen(process.env.PORT || 4730);
});

-

// api/kitten.js

var mongoose = require('mongoose');

var kittenSchema = mongoose.Schema({
  name: String
});

var Kitten = mongoose.model('Kitten', kittenSchema);

exports.findAll = function (res) {
  Kitten.find(function (err, kittens) {
    if (err) {
    }
    res.json(kittens);
  });
};

exports.findOne = function (req, res) {
  Kitten.findOne({ _id: req.params.id}, function (err, kitten) {
    if (err) {
    }
    res.json(kitten);
  });
};

显然，到目前为止，只实施了几种方法。大家觉得这种做法怎么样？有什么我可以改进的吗？

另外，还有一个小问题：我必须在每个 API 资源文件中都需要 mongoose（例如api\kitten.js，有没有办法在 app.js 文件中全局需要它？

非常感谢任何输入！

4

3 回答 3

14

好吧，您可以在不同的文件中分离出您的路线、数据库模型和模板。有一个类似这样的目录结构，

| your_app
| -- routes
| -- models
| -- templates
| -- static
    | -- css
    | -- js
    | -- images
| -- config.js
| -- app.js
| -- url.js
  • 对于每个 Mongoose 模型，都有一个单独的文件放置在您的./models
  • 在模板目录中放置您的玉文件。（假设您使用翡翠作为您的模板引擎）。尽管您似乎只提供 JSON，而不是 HTML。如果要呈现 HTML，请考虑使用 Jade。（以下是您可以考虑使用的其他几个模板引擎）
  • ./static静态 JS、CSS 和 XML 文件等的目录。
  • 诸如 db 连接或 3rd 方 API 密钥之类的东西可以放在 config.js 中
  • 在 url.js 中有一个以 express对象作为参数并在单个位置app扩展的过程。app.getapp.post

PS 这是我在 express 中用于基本 Web 应用程序的方法。我绝不是说这是最好的方法，但它可以帮助我维护我的代码。

于 2013-09-03T16:28:23.057 回答
6

没有正确的方法，但我确实为我的个人目录结构创建了一个种子应用程序来帮助我的室友。

你可以克隆它：git clone https://github.com/hboylan/express-mongoose-api-seed.git

或者使用 npm：npm install express-mongoose-api-seed

于 2014-02-25T20:22:13.633 回答
6

正如codemonger5所说，没有组织目录结构的正确方法。

但是，您可以使用这个样板应用程序使用 Express 和 mongoose 使用 ES6 创建 REST API。我们在生产 API 服务中使用相同的目录结构。

git clone https://github.com/KunalKapadia/express-mongoose-es6-rest-api
cd express-mongoose-es6-rest-api
npm install
npm start
于 2016-02-04T20:27:21.300 回答