first commit

Author: tienbku

.gitignore

@@ -0,0 +1,3 @@
+build
+node_modules
+package-lock.json

README.md

@@ -0,0 +1,76 @@
+# Express Typescript example: Build Node.js REST Api in Typescript
+Build Node.js Rest Api example using Express and Typescript that handles GET/POST/PUT/DELETE Http requests.
+
+| Methods	| Urls	| Actions
+| -------- | ------- | ------- |
+| GET | api/tutorials | get all Tutorials
+| GET | api/tutorials/:id | get Tutorial by id
+| POST | api/tutorials | add new Tutorial
+| PUT | api/tutorials/:id | update Tutorial by id
+| DELETE | api/tutorials/:id | remove Tutorial by id
+
+For more detail, please visit:
+> [Express Typescript example](https://www.bezkoder.com/express-typescript-example/)
+
+> [Node.js Typescript with MySQL example](https://www.bezkoder.com/node-js-typescript-mysql/)
+
+Using Sequelize:
+> [TypeScript ORM with MySQL example](https://www.bezkoder.com/typescript-orm-mysql/)
+
+> [TypeScript ORM with Postgres example](https://www.bezkoder.com/typescript-orm-postgres/)
+
+## Project setup
+```
+npm install
+```
+
+### Run
+```
+npm run start
+```
+
+## More Practice
+
+> [Node.js Express File Upload Rest API example](https://www.bezkoder.com/node-js-express-file-upload/)
+
+> [Server side Pagination in Node.js with Sequelize and MySQL](https://www.bezkoder.com/node-js-sequelize-pagination-mysql/)
+
+> [Deploying/Hosting Node.js app on Heroku with MySQL database](https://www.bezkoder.com/deploy-node-js-app-heroku-cleardb-mysql/)
+
+Security:
+> [Node.js Express: JWT example | Token Based Authentication & Authorization](https://www.bezkoder.com/node-js-jwt-authentication-mysql/)
+
+Associations:
+> [Sequelize Associations: One-to-Many Relationship example](https://www.bezkoder.com/sequelize-associate-one-to-many/)
+
+> [Sequelize Associations: Many-to-Many Relationship example](https://www.bezkoder.com/sequelize-associate-many-to-many/)
+
+Fullstack:
+> [Vue.js + Node.js + Express + MySQL example](https://www.bezkoder.com/vue-js-node-js-express-mysql-crud-example/)
+
+> [Vue.js + Node.js + Express + MongoDB example](https://www.bezkoder.com/vue-node-express-mongodb-mevn-crud/)
+
+> [Angular 8 + Node.js + Express + MySQL example](https://www.bezkoder.com/angular-node-express-mysql/)
+
+> [Angular 10 + Node.js + Express + MySQL example](https://www.bezkoder.com/angular-10-node-js-express-mysql/)
+
+> [Angular 11 + Node.js + Express + MySQL example](https://www.bezkoder.com/angular-11-node-js-express-mysql/)
+
+> [Angular 12 + Node.js + Express + MySQL example](https://www.bezkoder.com/angular-12-node-js-express-mysql/)
+
+> [Angular 13 + Node.js + Express + MySQL example](https://www.bezkoder.com/angular-13-node-js-express-mysql/)
+
+> [Angular 14 + Node.js + Express + MySQL example](https://www.bezkoder.com/angular-14-node-js-express-mysql/)
+
+> [Angular 15 + Node.js + Express + MySQL example](https://www.bezkoder.com/angular-15-node-js-express-mysql/)
+
+> [Angular 16 + Node.js + Express + MySQL example](https://www.bezkoder.com/angular-16-node-js-express-mysql/)
+
+> [React + Node.js + Express + MySQL example](https://www.bezkoder.com/react-node-express-mysql/)
+
+Integration (run back-end & front-end on same server/port)
+> [Integrate React with Node.js Restful Services](https://www.bezkoder.com/integrate-react-express-same-server-port/)
+
+> [Integrate Angular with Node.js Restful Services](https://www.bezkoder.com/integrate-angular-10-node-js/)
+
+> [Integrate Vue with Node.js Restful Services](https://www.bezkoder.com/serve-vue-app-express/)

package.json

@@ -0,0 +1,35 @@
+{
+  "name": "express-typescript-example",
+  "version": "1.0.0",
+  "description": "Rest API using Node.js, TypeScript, Express",
+  "main": "server.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
+    "dev": "node ./build/server.js",
+    "start": "tsc && npm run dev"
+  },
+  "keywords": [
+    "express",
+    "typescript",
+    "rest",
+    "api",
+    "restapi",
+    "node",
+    "nodejs",
+    "crud"
+  ],
+  "author": "bezkoder",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/cors": "^2.8.13",
+    "@types/express": "^4.17.17",
+    "@types/node": "^20.3.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.6"
+  },
+  "dependencies": {
+    "cors": "^2.8.5",
+    "express": "^4.18.2"
+  }
+}

server.ts

@@ -0,0 +1,18 @@
+import express, { Application } from "express";
+import Server from "./src/index";
+
+const app: Application = express();
+const server: Server = new Server(app);
+const PORT: number = process.env.PORT ? parseInt(process.env.PORT, 10) : 8080;
+
+app
+  .listen(PORT, "localhost", function () {
+    console.log(`Server is running on port ${PORT}.`);
+  })
+  .on("error", (err: any) => {
+    if (err.code === "EADDRINUSE") {
+      console.log("Error: address already in use");
+    } else {
+      console.log(err);
+    }
+  });

src/controllers/home.controller.ts

@@ -0,0 +1,5 @@
+import { Request, Response } from "express";
+
+export function welcome(req: Request, res: Response): Response {
+  return res.json({ message: "Welcome to bezkoder application." });
+}

src/controllers/tutorial.controller.ts

@@ -0,0 +1,68 @@
+import { Request, Response } from "express";
+
+export default class TutorialController {
+  async create(req: Request, res: Response) {
+    try {
+      res.status(201).json({
+        message: "create OK",
+        reqBody: req.body
+      });
+    } catch (err) {
+      res.status(500).json({
+        message: "Internal Server Error!"
+      });
+    }
+  }
+
+  async findAll(req: Request, res: Response) {
+    try {
+      res.status(200).json({
+        message: "findAll OK"
+      });
+    } catch (err) {
+      res.status(500).json({
+        message: "Internal Server Error!"
+      });
+    }
+  }
+
+  async findOne(req: Request, res: Response) {
+    try {
+      res.status(200).json({
+        message: "findOne OK",
+        reqParamId: req.params.id
+      });
+    } catch (err) {
+      res.status(500).json({
+        message: "Internal Server Error!"
+      });
+    }
+  }
+
+  async update(req: Request, res: Response) {
+    try {
+      res.status(200).json({
+        message: "update OK",
+        reqParamId: req.params.id,
+        reqBody: req.body
+      });
+    } catch (err) {
+      res.status(500).json({
+        message: "Internal Server Error!"
+      });
+    }
+  }
+
+  async delete(req: Request, res: Response) {
+    try {
+      res.status(200).json({
+        message: "delete OK",
+        reqParamId: req.params.id
+      });
+    } catch (err) {
+      res.status(500).json({
+        message: "Internal Server Error!"
+      });
+    }
+  }
+}

src/index.ts

@@ -0,0 +1,20 @@
+import express, { Application } from "express";
+import cors, { CorsOptions } from "cors";
+import Routes from "./routes";
+
+export default class Server {
+  constructor(app: Application) {
+    this.config(app);
+    new Routes(app);
+  }
+
+  private config(app: Application): void {
+    const corsOptions: CorsOptions = {
+      origin: "http://localhost:8081"
+    };
+
+    app.use(cors(corsOptions));
+    app.use(express.json());
+    app.use(express.urlencoded({ extended: true }));
+  }
+}

src/routes/home.routes.ts

@@ -0,0 +1,16 @@
+import { Router } from "express";
+import { welcome } from "../controllers/home.controller";
+
+class HomeRoutes {
+  router = Router();
+
+  constructor() {
+    this.intializeRoutes();
+  }
+
+  intializeRoutes() {
+    this.router.get("/", welcome);
+  }
+}
+
+export default new HomeRoutes().router;

src/routes/index.ts

@@ -0,0 +1,10 @@
+import { Application } from "express";
+import homeRoutes from "./home.routes";
+import tutorialRoutes from "./tutorial.routes";
+
+export default class Routes {
+  constructor(app: Application) {
+    app.use("/api", homeRoutes);
+    app.use("/api/tutorials", tutorialRoutes);
+  }
+}

src/routes/tutorial.routes.ts

@@ -0,0 +1,30 @@
+import { Router } from "express";
+import TutorialController from "../controllers/tutorial.controller";
+
+class TutorialRoutes {
+  router = Router();
+  controller = new TutorialController();
+
+  constructor() {
+    this.intializeRoutes();
+  }
+
+  intializeRoutes() {
+    // Create a new Tutorial
+    this.router.post("/", this.controller.create);
+
+    // Retrieve all Tutorials
+    this.router.get("/", this.controller.findAll);
+
+    // Retrieve a single Tutorial with id
+    this.router.get("/:id", this.controller.findOne);
+
+    // Update a Tutorial with id
+    this.router.put("/:id", this.controller.update);
+
+    // Delete a Tutorial with id
+    this.router.delete("/:id", this.controller.delete);
+  }
+}
+
+export default new TutorialRoutes().router;