express × Mongo DBでCRUDするweb APIを作る（その2 webAPIの作成と実行編）

// node.jsのバージョン
$ node -v
v14.17.6

// homebrewのバージョン
$ brew -v
Homebrew 3.3.4
Homebrew/homebrew-core (git revision 4567f25b438; last commit 2021-11-20)
Homebrew/homebrew-cask (git revision fbb42995b4; last commit 2021-11-20)

// Mongo DBのバージョン確認（私の場合は以下のバージョン）
$ mongod --version
db version v5.0.3

$mkdir express_crud
$cd express_crud

// init後はエンター連打で大丈夫です。
$npm init
This utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible defaults.

See `npm help init` for definitive documentation on these fields
and exactly what they do.

Use `npm install <pkg>` afterwards to install a package and
save it as a dependency in the package.json file.

Press ^C at any time to quit.
package name: (express_crud) [ここでエンター]
version: (1.0.0)  [ここでエンター]
description: [ここでエンター]
entry point: (index.js)  [ここでエンター]
test command:  [ここでエンター]
git repository: [ここでエンター]
keywords:  [ここでエンター]
author:  [ここでエンター]
license: (ISC)  [ここでエンター]
About to write to /Users/[ユーザー名が表示されている]/Desktop/express_crud/package.json:

{
  "name": "express_crud",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}


Is this OK? (yes)  [ここでエンター]

// express install
$npm i express
....[割愛します。]


// nodeman install(ホットリロード的なやつ)
$npm i -D nodemon
....[割愛します。]

// mongoose install(ODM。ORMのmongo版的なやつ)
$npm i mongoose 
....[割愛します。]

{
  "name": "express_crud",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "nodemon ./api/index.js" // この行を追加します。
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "express": "^4.17.2",
    "mongoose": "^6.1.3"
  },
  "devDependencies": {
    "nodemon": "^2.0.15"
  }
}

// express_crud/api/index.jsファイルにて

// expressを読み込む（使えるようにする）
const express = require('express')

//expressの関数をappで実行できるようにする（通常、appで実行できるようにすることが多い）
const app = express()

// 先ほど作成したroutes/index.jsファイルを読み込む（使えるようにする）
// この時点ではroutes/index.jsには何も書いていないです。
const router = require('./routes')

// ポートの指定（環境変数（process.env.PORT）か3000番）
const port = process.env.PORT || 3000

// mongooseを読み込む（使えるようにする）
const mongoose = require('mongoose')

// ローカルで実行しているcompanyデータベースに接続（デフォルトのポートが27017）
mongoose.connect('mongodb://localhost:27017/company')

// bodyParserは非推奨になったので、この形で書く
// 入力されたデータを文字列または配列として認識する
// Content-Typeがapplication/x-www-form-urlencodedのデータを取得するためにはexpress.urlencoded()を追加する必要がある
// extendedオプションはデフォルトでfalseに設定されており、配列型のフォームデータを受け取る際にはtrueに変更する必要がある
app.use(express.urlencoded({ extended: true }))

// 受け取ったデータをJSONオブジェクトとして認識する
// Content-Typeがapplication/jsonのデータを取得するためにはexpress.json()を追加する必要がある
app.use(express.json())
app.use('/api', router)

// 先ほど指定したport番号でlistenする。
app.listen(port)

//ログを出力
console.info('listen on port: ' + port)

const express = require('express')
const app = express()

// const router = require('./routes')

const port = process.env.PORT || 3000

const mongoose = require('mongoose')

mongoose.connect('mongodb://localhost:27017/company')

app.use(express.urlencoded({ extended: true }))

// app.use(express.json())
// app.use('/api', router)

app.listen(port)
console.info('listen on port: ' + port)

//package.jsonの"scripts"に"start"を変更したため、再度package.json の内容をインストールする
$ npm i
...[割愛]
$ npm run start
> express_crud@1.0.0 start /Users/[私のユーザー名]/Desktop/express_crud
> nodemon index.js

[nodemon] 2.0.15
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): *.*
[nodemon] watching extensions: js,mjs,json
[nodemon] starting `node index.js`
listen on port: 3000

// const router = require('./routes')
// app.use(express.json())
// app.use('/api', router)

// express_crud/api/routes/index.jsファイルにて

// expressを読み込む（使えるようにする）
const express = require('express')

// expressのRouter関数をrouterという名前で定義する
const router = express.Router()

// express_crud/api/routes/user.jsファイルを読み込む（使えるようにする）
// この時点ではこのファイルの中身は空です。（次で作成します）
const users = require('./user')

// routerに/userの中身を/usersというURLがリクエストされた時に呼び出すものとして定義する
router.use("/users", users)

// routerをexportする
module.exports = router

// express_crud/api/routes/user.jsファイルにて

///controllers/userController.jsを読み込む（使えるようにする）
const userController = require('../controllers/userController')

// expressを読み込む（使えるようにする）
const express = require('express')

// expressのRouter関数をrouterという名前で定義する
const router = express.Router()

// localhost:3000/api/users/　でgetリクエストが飛んできた時に実行されるコード
// ここでは、userControllerファイルに記載されているfind_users関数を実行して、結果を返す処理を実施
router.get('/', async (req, res) => {
  return await userController.find_users(req, res)
})

// localhost:3000/api/users/　でpostリクエストが飛んできた時に実行されるコード
router.post('/', async (req, res) => {
  return await userController.create_user(req, res)
})

// localhost:3000/api/users/id番号/　でgetリクエストが飛んできた時に実行されるコード
router.get('/:id', async (req, res) => {
  return await userController.find_user(req, res)
})

// localhost:3000/api/users/id番号/　でputリクエストが飛んできた時に実行されるコード
router.put('/:id', async (req, res) => {
  return await userController.update_user(req, res)
})

// localhost:3000/api/users/id番号/　でdeleteリクエストが飛んできた時に実行されるコード
router.delete('/:id', async (req, res) => {
  return await userController.delete_user(req, res)
})

module.exports = router

// express_crud/api/controllers/userController.jsファイルにて

// express_crud/api/models/user.jsファイルを読み込む
// この時点ではこのファイルには何も記述はありません。
const User = require('../models/user')

module.exports = {
  // 全てのユーザーを取得する。（json形式でUser.find({})の結果を返す）
  find_users : async (req, res) => {
    const users = await User.find({}).catch(err => {
      res.send(err)
      console.error(err)
    })
    return res.json(users)
  },

  // 新しいユーザーを作成する。
  create_user : async (req, res) => {
    const user = new User()
    user.name = req.body.name
    user.age = req.body.age
    user.permanent_staff = req.body.permanent_staff

    await user.save().catch(err => {
      res.send(err)
      console.error(err)
    })
    return res.json(user)
  },


  // 特定のユーザーを取得する。
  find_user : async (req, res) => {
    const user = await User.findById(req.params.id).catch(err => {
      res.send(err)
      console.error(err)
    })
    return res.json(user)
  },

  // 特定のユーザーを更新する。
  update_user : async (req, res) => {
    const user = await User.findById(req.params.id).catch(err => {
      res.send(err)
      console.error(err)
    })
    user.name = req.body.name
    user.age = req.body.age
    user.permanent_staff = req.body.permanent_staff
    await user.save()
    return res.json(user)
  },

  // 特定のユーザーを削除する。
  delete_user : async (req, res) => {
    await User.deleteOne({
      _id: req.params.id
    }).catch(err => {
      res.send(err)
      console.error(err)
    })
    return res.json({ message: "Successfully deleted"})
  }
}

// express_crud/api/models/user.jsファイルにて

const mongoose = require('mongoose')
const Schema = mongoose.Schema

const UserSchema = new Schema({
  name: {
    type: String,
    required: true
  },
  age: {
    type: Number,
    default: 0
  },
  permanent_staff: {
    type: Boolean,
    default: true
  }
})

// スキーマからUserモデルを生成する
module.exports = mongoose.model('User', UserSchema)

$ npm run start

> express_crud@1.0.0 start /Users/[私のユーザー名]/Desktop/express_crud
> nodemon index.js

[nodemon] 2.0.15
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): *.*
[nodemon] watching extensions: js,mjs,json
[nodemon] starting `node index.js`
listen on port: 3000