typeORMの導入、GETAPIでDBのデータを取得

Author: nakamurakzz

.gitignore

@@ -1,3 +1,5 @@
+volumes
+
 # Logs
 logs
 *.log

README.md

@@ -15,4 +15,24 @@ yarn
 起動
 ```
 yarn start
-```
+```
+
+2. method
+インストール
+```
+cd samples/method
+yarn
+```
+
+DB起動
+```
+// samplesディレクトリに移動
+cd ../
+docker-compose up -d
+```
+
+起動
+```
+cd samples/method
+yarn start
+```

samples/docker-compose.yml

@@ -0,0 +1,25 @@
+# Use root/example as user/password credentials
+version: '3.1'
+
+services:
+
+  db:
+    image: mysql
+    command: --default-authentication-plugin=mysql_native_password
+    restart: always
+    ports:
+      - 13306:3306
+    volumes:
+      - ./volumes/example_db/db/data:/var/lib/mysql
+      - ./volumes/example_db/db/my.cnf:/etc/mysql/conf.d/my.cnf
+    environment:
+      MYSQL_DATABASE: example_db
+      MYSQL_ROOT_PASSWORD: example
+      MYSQL_USER: docker
+      MYSQL_PASSWORD: docker
+
+  adminer:
+    image: adminer
+    restart: always
+    ports:
+      - 8080:8080

samples/hello-world/src/index.ts

@@ -1,4 +1,5 @@
 import express from 'express'
+import "reflect-metadata"
 
 const app: express.Express = express()
 

samples/method/data-source.ts

@@ -0,0 +1,16 @@
+import { DataSource } from "typeorm";
+
+const AppDataSource = new DataSource({
+  type: "mysql",
+  host: "localhost",
+  port: 13306,
+  username: "docker",
+  password: "docker",
+  database: "example_db",
+  synchronize: false,
+  logging: true,
+  entities: ["src/entities/**/*.ts"],
+  migrations: ["src/migrations/**/*.ts"],
+})
+
+export default AppDataSource

samples/method/docs/reference/tutorial-api.yaml

@@ -44,11 +44,11 @@ paths:
                   $ref: '#/components/schemas/Content'
       tags:
         - Content
-  '/contents/{contentsId}':
+  '/contents/{contentId}':
     parameters:
       - schema:
           type: string
-        name: contentsId
+        name: contentId
         in: path
         required: true
     get:

samples/method/nodemon.json

@@ -0,0 +1,7 @@
+{
+  "watch": [
+    "src"
+  ],
+  "ext": "ts",
+  "exec": "ts-node -r tsconfig-paths/register ./src/index.ts"
+}

samples/method/package.json

@@ -4,15 +4,22 @@
   "main": "index.js",
   "license": "MIT",
   "scripts": {
+    "dev": "./node_modules/.bin/nodemon",
     "start": "ts-node src/index.ts",
     "lint": "eslint --fix './src/**/*.{js,jsx,ts,tsx}'",
-    "format": "prettier --write ./src"
+    "format": "prettier --write ./src",
+    "make:migration": "typeorm-ts-node-commonjs migration:generate ./src/migrations -d ./data-source.ts",
+    "migrate": "typeorm-ts-node-commonjs migration:run -d ./data-source.ts",
+    "rollback": "typeorm-ts-node-commonjs migration:revert -d ./data-source.ts"
   },
   "dependencies": {
     "@typescript-eslint/eslint-plugin": "^5.32.0",
     "@typescript-eslint/parser": "^5.32.0",
     "eslint": "^7.32.0 || ^8.2.0",
-    "express": "^4.18.1"
+    "express": "^4.18.1",
+    "nodemon": "^2.0.19",
+    "reflect-metadata": "^0.1.13",
+    "typeorm": "^0.3.7"
   },
   "devDependencies": {
     "@types/express": "^4.17.13",

samples/method/sql/create_content_table.sql

@@ -0,0 +1,4 @@
+CREATE TABLE `content` (
+	id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
+	title VARCHAR(256),
+	body VARCHAR(1024)) ENGINE = InnoDB;

samples/method/src/entities/Content.ts

@@ -0,0 +1,18 @@
+import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm'
+
+@Entity()
+export class Content {
+  @PrimaryGeneratedColumn()
+  id!: number
+
+  @Column('varchar')
+  title: string
+
+  @Column('varchar')
+  body: string
+
+  constructor(title: string, body: string) {
+    this.title = title
+    this.body = body
+  }
+}

samples/method/src/index.ts

@@ -1,5 +1,6 @@
 import express from 'express'
-import { contents } from './constants'
+import AppDataSource from '../data-source'
+import { Content } from './entities/Content'
 
 const app: express.Express = express()
 
@@ -14,13 +15,29 @@ app.use((req, res, next) => {
 app.use(express.json())
 app.use(express.urlencoded({ extended: true }))
 
-// Get /contents
+AppDataSource.initialize()
+
 const router: express.Router = express.Router()
-router.get('/contents', (req: express.Request, res: express.Response) => {
+
+const repository = AppDataSource.getRepository(Content)
+
+// GET /contents
+router.get('/contents', async (req: express.Request, res: express.Response) => {
+  const contents = await repository.find()
   res.send(contents)
 })
-app.use(router)
 
+// GET /contents/:id
+router.get('/contents/:id', async (req: express.Request, res: express.Response) => {
+  const content = await repository.findOne({
+    where: { id: Number(req.params.id) },
+    order: { id: 'ASC' },
+  })
+  if (content == null) res.status(404).send()
+  res.send(content)
+})
+
+app.use(router)
 // 3000番ポートでAPIサーバ起動
 app.listen(3000, () => {
   console.log('Example app listening on port 3000!')

samples/method/src/migrations/1659710150627-migrations.ts

@@ -0,0 +1,15 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class migrations1659710150627 implements MigrationInterface {
+  name = 'migrations1659710150627'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TABLE \`content\` (\`id\` int NOT NULL AUTO_INCREMENT, \`title\` varchar(255) NOT NULL, \`body\` varchar(255) NOT NULL, PRIMARY KEY (\`id\`)) ENGINE=InnoDB`
+    )
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`DROP TABLE \`content\``)
+  }
+}

samples/method/tsconfig.json

@@ -14,8 +14,8 @@
     "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
     // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
     // "jsx": "preserve",                                /* Specify what JSX code is generated. */
-    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
-    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
     // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
     // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
     // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */