GET, POST, PUT, DELETE APIの作成、DB構築

.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/.eslintrc.js

@@ -0,0 +1,20 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+  },
+  extends: [
+    'airbnb-base',
+    'prettier',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  plugins: [
+    '@typescript-eslint',
+  ],
+  rules: {
+  },
+};

samples/method/.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  singleQuote: true,
+  trailingComma: 'es5',
+  printWidth: 100,
+  semi: false,
+}

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

@@ -0,0 +1,146 @@
+openapi: 3.0.0
+x-stoplight:
+  id: 70he5bttrcegx
+info:
+  title: tutorial-api
+  version: '1.0'
+servers:
+  - url: 'http://localhost:3000'
+paths:
+  /contents:
+    post:
+      summary: Create New Content
+      operationId: post-content
+      responses:
+        '200':
+          description: Content Created
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Content'
+              examples: {}
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PostContentRequest'
+            examples: {}
+        description: Post the necessary fields for the API to create a new content.
+      description: Create a new content.
+    parameters: []
+    get:
+      summary: Get Contents
+      operationId: get-contents
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Content'
+      tags:
+        - Content
+  '/contents/{contentId}':
+    parameters:
+      - schema:
+          type: string
+        name: contentId
+        in: path
+        required: true
+    get:
+      summary: Get Content Info by Content ID
+      tags:
+        - Content
+      responses:
+        '200':
+          description: Content Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Content'
+              examples:
+                Get Content Alice Smith:
+                  value:
+                    id: 142
+                    firstName: Alice
+                    lastName: Smith
+                    email: [email protected]
+                    dateOfBirth: '1997-10-31'
+                    emailVerified: true
+                    signUpDate: '2019-08-24'
+      operationId: get-contents-contentId
+      description: Retrieve the information of the content with the matching content ID.
+    delete:
+      summary: Delete a Content by Content ID
+      operationId: delete-contents-contentsId
+      responses:
+        '204':
+          description: No Content
+      tags:
+        - Content
+    put:
+      summary: Update a Content
+      operationId: put-contents-contentsId
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Content'
+      tags:
+        - Content
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PostContentRequest'
+      description: 一部のパラメータのみの更新も可能とする
+components:
+  schemas:
+    Content:
+      title: Content
+      type: object
+      description: ''
+      x-examples:
+        Alice Smith:
+          id: 142
+          firstName: Alice
+          lastName: Smith
+          email: [email protected]
+          dateOfBirth: '1997-10-31'
+          emailVerified: true
+          signUpDate: '2019-08-24'
+      properties:
+        id:
+          type: integer
+          description: Unique identifier for the given content.
+        title:
+          type: string
+        body:
+          type: string
+        createdAt:
+          type: string
+          format: date
+          description: The date that the content was created.
+        updatedAt:
+          type: string
+      required:
+        - id
+        - title
+        - body
+    PostContentRequest:
+      title: PostContentRequest
+      x-stoplight:
+        id: uyyane08s9ozp
+      type: object
+      properties:
+        title:
+          type: string
+        body:
+          type: string
+  requestBodies: {}

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

@@ -0,0 +1,34 @@
+{
+  "name": "hello-world",
+  "version": "1.0.0",
+  "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",
+    "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",
+    "nodemon": "^2.0.19",
+    "reflect-metadata": "^0.1.13",
+    "typeorm": "^0.3.7"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.13",
+    "@types/node": "^18.6.4",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.25.2",
+    "prettier": "^2.7.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
+  }
+}

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/constants.ts

@@ -0,0 +1,16 @@
+export const contents = [
+  {
+    id: 1,
+    title: '坊っちゃん',
+    body: '親譲りの無鉄砲で小供の時から損ばかりしている。小学校に居る時分学校の二階から飛び降りて一週間ほど腰を抜かした事がある。なぜそんな無闇をしたと聞く人があるかも知れぬ。別段深い理由でもない。新築の二階から首を出していたら、同級生の一人が冗談に、いくら威張っても、そこから飛び降りる事は出来まい。弱虫やーい。と囃したからである。小使に負ぶさって帰って来た時、おやじが大きな眼をして二階ぐらいから飛び降りて腰を抜かす奴があるかと云ったから、この次は抜かさずに飛んで見せますと答えた。\n\n親譲りの無鉄砲で小供の時から損ばかりしている。小学校に居る時分学校の二階から飛び降りて一週間ほど腰を抜かした事がある。なぜそんな無闇をしたと聞く人があるかも知れぬ。別段深い理由でもない。新築の二階から首を出していたら、同級生の一人が冗談に、いくら威張っても、そこから飛び降りる事は出来まい。弱虫やーい。と囃したからである。小使に負ぶさって帰って来た時、おやじが大きな眼をして二階ぐらいから飛び降りて腰を抜かす奴があるかと云ったから、この次は抜かさずに飛んで見せますと答えた。',
+    createdAt: new Date(),
+    updatedAt: new Date(),
+  },
+  {
+    id: 2,
+    title: '方丈記',
+    body: '行く川のながれは絶えずして、しかも本の水にあらず。よどみに浮ぶうたかたは、かつ消えかつ結びて久しくとゞまることなし。世の中にある人とすみかと、またかくの如し。玉しきの都の中にむねをならべいらかをあらそへる、たかきいやしき人のすまひは、代々を經て盡きせぬものなれど、これをまことかと尋ぬれば、昔ありし家はまれなり。或はこぞ破れ（やけイ）てことしは造り、あるは大家ほろびて小家となる。住む人もこれにおなじ。所もかはらず、人も多かれど、いにしへ見し人は、二三十人が中に、わづかにひとりふたりなり。あしたに死し、ゆふべに生るゝならひ、たゞ水の泡にぞ似たりける。知らず、生れ死ぬる人、いづかたより來りて、いづかたへか去る。又知らず、かりのやどり、誰が爲に心を惱まし、何によりてか目をよろこばしむる。そのあるじとすみかと、無常をあらそひ去るさま、いはゞ朝顏の露にことならず。或は露おちて花のこれり。のこるといへども朝日に枯れぬ。或は花はしぼみて、露なほ消えず。消えずといへども、ゆふべを待つことなし。』およそ物の心を知れりしよりこのかた、四十あまりの春秋をおくれる間に、世のふしぎを見ることやゝたびたびになりぬ。いにし安元三年四月廿八日かとよ、風烈しく吹きてしづかならざりし夜、戌の時ばかり、都のたつみより火出で來りていぬゐに至る。はてには朱雀門、大極殿、大學寮、民部の省まで移りて、ひとよがほどに、塵灰となりにき。火本は樋口富の小路とかや、病人を宿せるかりやより出で來けるとなむ。吹きまよふ風にとかく移り行くほどに、扇をひろげたるが如くすゑひろになりぬ。遠き家は煙にむせび、近きあたりはひたすらほのほを地に吹きつけたり。空には灰を吹きたてたれば、火の光に映じてあまねくくれなゐなる中に、風に堪へず吹き切られたるほのほ、飛ぶが如くにして一二町を越えつゝ移り行く。その中の人うつゝ（しイ）心ならむや。あるひは煙にむせびてたふれ伏し、或は炎にまぐれてたちまちに死しぬ。或は又わづかに身一つからくして遁れたれども、資財を取り出づるに及ばず。七珍萬寳、さながら灰燼となりにき。そのつひえいくそばくぞ。このたび公卿の家十六燒けたり。ましてその外は數を知らず。すべて都のうち、三分が二（一イ）に及べりとぞ。男女死ぬるもの數千人、馬牛のたぐひ邊際を知らず。人のいとなみみなおろかなる中に、さしも危き京中の家を作るとて寶をつひやし心をなやますことは、すぐれてあぢきなくぞ侍るべき。』また治承四年卯月廿九日のころ、中の御門京極のほどより、大なるつじかぜ起りて、六條わたりまで、いかめしく吹きけること侍りき。三四町をかけて吹きまくるに、その中にこもれる家ども、大なるもちひさきも、一つとしてやぶれざるはなし。さながらひらにたふれたるもあり。',
+    createdAt: new Date(),
+    updatedAt: new Date(),
+  },
+]

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
+  }
+}