ساخت RESTful API با Node و Express – بخش اول

ساخت RESTful API با Node و Express – بخش اول

امروزه بیشتر سایت ها، API خود را به کاربران خود ارائه می دهند. در این پست می خواهیم با استفاده از Node.js و فریم ورک Express.js یک RESTful API درست کنیم و همچنین با ماژول Mongoose با دیتابیس MongoDB تعامل داشته باشیم.

بیایید با هم مرور کنیم این API که قرار است درست کنیم چه کاری را انجام می دهد.

قصد داریم API ایجاد کنیم که:

  • عملیات CRUD را انجام می دهد.
  • داشتن URL های استاندارد مثل http://example.com/api/persons و http://example.com/api/persons/:person_id
  • استفاده از GET / POST / PUT / DELETE
  • نمایش داده ها بصورت JSON
  • چاپ تمام درخواست ها در کنسول

 

شروع

اجازه دهید ابتدا فایل هایی که برای ایجاد این API لازم است را آماده کنیم. ما قصد داریم ابتدا پکیج های Node خود را تعریف کنیم، و همچنین اجرا سرور از طریق Express، ایجاد مدل، تعریف مسیرهای (router) برنامه با Express در دستور کار ما است.

ساختار برنامه ما بصورت زیر خواهد بود:

همانطور که می دانیم هر برنامه Node نیازمند فایل package.json است تا وابستگی های خود را مشخص کند. این فایل را بطور دستی یا با دستور npm init ایجاد کنید و با توجه به داده های زیر آن را کامل کنید:

در این برنامه از express که یک فریم ورک Node استفاده کرده ایم. mongoose یک ORM است که با دیتابیس MongoDB در ارتباط است همانند Elequent برای لاراول یا Doctrine برای سیمفونی. body-parser این اجازه را می دهد تا داده های POST را از درخواست HTTP گرفته و همچنین باعث می شود شخص جدیدی (داده های جدید، در این برنامه مظور person جدید است) را به برنامه خود اضافه کنیم.

حال با استفاده از دستور npm install در ریشه برنامه خود پکیج هایی که در فایل package.json مشخص کرده ایم را نصب کنید. این کار باعث می شود این پکیج های وابسته در پوشه node_modules ذخیره شوند.

 

راه اندازی سرور نود.جی.اس

همانطور که مشاهده می کنید کدهای فوق بسیار واضح هستند. برای تست برنامه را با دستور node app.js اجرا کنید و به آدرس http://localhost:3001/api مراجعه کنید. اگر پیام Hello, World را بصورت JSON مشاهده کردید به این معنی است که مشکلی وجود ندارد و می توانید ادامه دهید.

 

ساخت RESTfull API در Node.js

تست برنامه با استفاده از POSTMAN

Postman به ما کمک می کند تا API خود را تست کنیم. به عبارتی به انتخاب با درخواست های HTTP را به URL ما ارسال می کند. حتی می توان پارامترهایی را به URL ارسال کرد.

برنامه Postman را اجرا کنید تا ببینیم چطور باید از آن استفاده کرد.

آموزش node.js

تمام کاری که باید انجام دهید این است که آدرس URL و نوع HTTP را مشخص کنید و دکمه Send را کلیک کنید. به همین راحتی!

این همان لحظه ای است که منتظرش بودیم. آیا برنامه ما همانطوری که انتظارش را داریم کار خواهد کرد؟

آدرس http://localhost:3001/api در URL وارد کنید. GET باعث می شود فقط داده ها را مشاهده کنیم. حال Send را کلیک کنید.

آموزش node.js

خیلی خوب! این همان چیز بود که انتظار داشتیم.

در بخش بعدی دیتابیس خود را آماده می کنیم تا عملیات CRUD را بر روی برنامه خود پیاده سازی کنیم. در انتهای این آموزش، مراحل ساخت این برنامه بصورت ویدئو قرار داده خواهد شد.