In this tutorial, you will learn how to setup a Node.js API using TypeScript. In the previous tutorials, we created an API using Node.js and Javascript. You can find them below:<\/p>\n
We would follow the steps to first setup Node.js application, then TypeScript and finally build an API. We would do the following:<\/p>\n
<\/p>\n
Step 1<\/strong> – Create a folder and open this folder using IntelliJ<\/p>\n Step 2<\/strong> – Initialize Node.js using the command npm init<\/strong> and then npm install<\/strong>.<\/p>\n Step 3<\/strong> – Then you need to install Typescript using globally<\/p>\n This provides the typescript compiler which makes it possible to compile Typescript code into JavaScript<\/p>\n Step 4<\/strong> –\u00a0 Install the following dependencies<\/p>\n <\/p>\n Step 1<\/strong>\u00a0– Initialize TypeScript using the command tsc –init<\/strong><\/em><\/p>\n This would create the tsconfig.json file.<\/p>\n Step 2<\/strong> – Open the tsconfig.json file and ensure the following settings are enabled<\/p>\n <\/p>\n We would now modify the package.json file to do two things:<\/p>\n With the above code, the typescript files would be build and compiled into JavaScript file.<\/p>\n Then we can start the server using the command npm run dev<\/p>\n <\/p>\n We would have to create a server that startups up when we issue the command npm run dev.<\/p>\n Step 1<\/strong> – Create a file named server.ts outside the src directory. The content of the file is given below:<\/p>\n This script basically tells node.js to use the routes specified in the app-routes.ts file. Then it should listen for request coming in port 6600<\/p>\n <\/p>\n We would have to create an src folder that would hold our application files. Then inside the src folder, we would have 3 folders: services, controller and routes<\/p>\n Step 1<\/strong> – Create the src folder<\/p>\n Step 2<\/strong> – Inside the src folder, create 3 folders: services, controllers and routes<\/p>\n Step 3<\/strong> – Inside the controllers folder, create a file named home-controller.ts<\/strong><\/em>. This would be the content<\/p>\n <\/p>\n Step 4<\/strong> – Inside the services folder, create a file named home-service.ts<\/strong><\/em>. This would be the content<\/p>\n <\/p>\n Step 5<\/strong> – Inside the routes folder, create a file named app-routes.ts<\/em><\/strong>, this would be the content<\/p>\n <\/p>\n At this point we have setup the API with TypeScript and now you can run the application using the command npm run dev<\/strong><\/em>.<\/p>\n Then you can access the \/home url and see that you get a response!<\/p>\n In the next part, we would then write the services that retrieves data from PostgreSQL database.<\/p>\n <\/p>\n","protected":false},"excerpt":{"rendered":" In this tutorial, you will learn how to setup a Node.js API using TypeScript. In the previous tutorials, we created an API using Node.js and … <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"footnotes":""},"categories":[2],"tags":[31],"class_list":["post-256","post","type-post","status-publish","format-standard","hentry","category-node-js-tutorials","tag-typescript"],"_links":{"self":[{"href":"https:\/\/kindsonthegenius.com\/nodejs\/wp-json\/wp\/v2\/posts\/256","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/kindsonthegenius.com\/nodejs\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/kindsonthegenius.com\/nodejs\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/kindsonthegenius.com\/nodejs\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/kindsonthegenius.com\/nodejs\/wp-json\/wp\/v2\/comments?post=256"}],"version-history":[{"count":7,"href":"https:\/\/kindsonthegenius.com\/nodejs\/wp-json\/wp\/v2\/posts\/256\/revisions"}],"predecessor-version":[{"id":281,"href":"https:\/\/kindsonthegenius.com\/nodejs\/wp-json\/wp\/v2\/posts\/256\/revisions\/281"}],"wp:attachment":[{"href":"https:\/\/kindsonthegenius.com\/nodejs\/wp-json\/wp\/v2\/media?parent=256"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/kindsonthegenius.com\/nodejs\/wp-json\/wp\/v2\/categories?post=256"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/kindsonthegenius.com\/nodejs\/wp-json\/wp\/v2\/tags?post=256"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}\n
2. Initialize and Configure tsconfig.json<\/strong><\/h4>\n
\"compilerOptions\"<\/span>:<\/span> {\r\n \"forceConsistentCasingInFileNames\"<\/span>: true<\/span>,\r\n \"module\"<\/span>: \"commonjs\"<\/span>,\r\n \"esModuleInterop\"<\/span>: true<\/span>,\r\n \"outDir\"<\/span>: \".\/build\"<\/span>,\r\n \"rootDir\"<\/span>: \".\/src\"<\/span>,\r\n \"target\"<\/span>: \"es6\"<\/span>,\r\n \"skipLibCheck\"<\/span>: true<\/span>,\r\n \"strict\"<\/span>: true<\/span>\r\n}\r\n<\/pre>\n3. Modify the package.json File<\/strong><\/h4>\n
\n
\"main\"<\/span>:<\/span> \"source\/server.ts\"<\/span>,<\/span>\r\n\"scripts\"<\/span>:<\/span> {\r\n \"dev\"<\/span>: \"nodemon source\/server.ts\"<\/span>,\r\n \"build\"<\/span>: \"rm -rf build\/ && prettier --write source\/ && tsc\"<\/span>\r\n}\r\n<\/pre>\n4. Create the Server<\/strong><\/h4>\n
import<\/span> http from 'http'<\/span>\r\nimport<\/span> express, {Express} from 'express'<\/span>\r\nimport<\/span> routes from '..\/src\/routes\/app-routes'<\/span>\r\n\r\nconst<\/span> router: Express<\/span> =<\/span> express();\r\nrouter.use('\/'<\/span>, routes)\r\n\r\nconst<\/span> httpServer =<\/span> http.createServer(router)\r\n\r\nhttpServer.listen(6600<\/span>, ()=><\/span>{\r\n console.log(`<\/span>Server is running at port 6600<\/span>`<\/span>);\r\n})\r\n<\/pre>\n5. Setup the Application Structure<\/strong><\/h4>\n
import<\/span> {Request, Response} from 'express'<\/span>;\r\nimport<\/span> *<\/span> as<\/span> service from '..\/services\/home-service'<\/span>\r\n\r\nconst<\/span> getHome =<\/span> async (req: Request<\/span>, res: Response<\/span>) =><\/span> {\r\n return<\/span> res.send(service.goHome());\r\n};\r\n\r\nexport<\/span> default<\/span> {getHome}\r\n<\/pre>\nexport<\/span> function<\/span> goHome() {\r\n return<\/span> \"Kindson is here now yesss\"<\/span>!<\/span>\r\n}\r\n<\/pre>\nimport<\/span> express from 'express'<\/span>\r\nimport<\/span> controller from '..\/controllers\/home-controller'<\/span>\r\n\r\nconst<\/span> router =<\/span> express.Router();\r\n\r\nrouter.get('\/home'<\/span>, controller.getHome);\r\n\r\nexport<\/span> =<\/span> router;\r\n<\/pre>\n