لینکهای مفید برای شرکت در مسابقه:
این سؤال تنها با زبانهای PHP ، Python ، Go و JS (Node.js) قابل حل است.
دیجیکالا قصد دارد برای بخش تحویل محصولات خود یک سامانهی سادهی ثبت پیشنهادات و انتقادات راهاندازی کند. از شما میخواهیم یک API برای این سامانه طراحی کنید.
پروژهی اولیه را از این لینک دانلود کنید.
در این سؤال، یک REST API شامل endpoint های زیر باید پیادهسازی شود:
آدرس | عنوان |
---|---|
GET / |
بررسی up بودن سرویس |
POST /signup |
ثبتنام |
POST /login |
ورود به حساب کاربری |
POST /suggestions |
درج پیشنهاد یا انتقاد |
GET /suggestions |
دریافت لیست پیشنهادات و انتقادات |
در این API هر کاربر باید یک توکن داشته باشد. این توکن برای هر کاربر ثابت است.
در همهی endpoint ها، پاسخ باید بهصورت JSON باشد.
اطلاعات ورودی بهصورت application/x-www-form-urlencoded
به endpoint ها ارسال میشوند.
پاسخ این endpoint باید بهصورت زیر باشد:
200
{"ok":true}
دو پارامتر username
و password
باید به این endpoint ارسال شوند. در صورتی که حداقل یکی از این پارامترها ارسال نشده باشد یا برابر با رشتهی خالی باشد، پاسخ باید بهصورت زیر باشد:
400
{"ok":false,"error":"no username or password provided"}
اگر کاربری با نام کاربری واردشده از قبل موجود باشد، پاسخ باید بهصورت زیر باشد:
400
{"ok":false,"error":"user already exists"}
در غیر اینصورت، کاربر باید ساخته شود، یک توکن یکتا برایش تولید شود و پاسخ بهصورت زیر باشد:
201
{"ok":true,"token":"USER_TOKEN"}
دو پارامتر username
و password
باید به این endpoint ارسال شوند. در صورتی که حداقل یکی از این پارامترها ارسال نشده باشد یا برابر با رشتهی خالی باشد، پاسخ باید بهصورت زیر باشد:
400
{"ok":false,"error":"no username or password provided"}
اگر نام کاربری یا رمز عبور نادرست باشد، پاسخ باید بهصورت زیر باشد:
400
{"ok":false,"error":"invalid username or password"}
در غیر اینصورت، پاسخ باید بهصورت زیر باشد:
200
{"ok":true,"token":"USER_TOKEN"}
این endpoint نیازمند authentication است. در ریکوئست ارسالی مقدار هدر Authorization
باید برابر با توکن کاربر باشد (بدون Bearer
یا موارد مشابه).
پارامتر text
(متن پیشنهاد یا انتقاد) باید به این endpoint ارسال شود. در صورتی که این پارامتر ارسال نشده باشد یا برابر با رشتهی خالی باشد، پاسخ باید بهصورت زیر باشد:
400
{"ok":false,"error":"no text provided"}
در غیر اینصورت، پیشنهاد یا انتقاد باید ثبت شود و پاسخ بهصورت زیر باشد:
201
{"ok":true}
این endpoint باید لیست پیشنهادات و انتقادات ثبتشده در سامانه را در قالب یک لیست برگرداند. این لیست شامل پیشنهادات و انتقادات ثبتشده توسط همهی کاربران است.
200
برای حل این سؤال میتوانید از هر زبان و هر تکنولوژیای که میخواهید استفاده کنید. بهصورتی که در یک پوشه به نام api
کد برنامه را نوشته و در فایلی به نام runner.sh
که توسط sh
اجرا میشود، باید برنامهی خود را اجرا کنید. توجه کنید که حتماً باید Dockerfile
مربوط به پروژهی خود را برای ما ارسال کنید.
در پروژهی اولیه، ۴ داکرفایل برای php
، python
، golang
و node
قرار دادیم که میتوانید از آنها مستقیماً استفاده کنید. در صورتی که از یکی از این زبانها برای حل سؤال استفاده میکنید، کافیست که Dockerfile
مربوط به آن را در پوشهی api
کپی کنید و طبق توضیحات داده شده، سؤال را حل کنید. برای نصب نیازمندیهای پایتون از requirements.txt
، برای پیاچپی از composer.json
، برای گولنگ از go.mod
و برای نودجیاس از package.json
استفاده کنید.
در صورتی که زبان مورد استفادهی شما، چیزی به جز این ۴ مورد است، باید خودتان داکرفایلی در پوشهی api
بهشکلی بنویسید که بتواند نیازمندیهای پروژهی شما را نصب کرده و برنامهی شما را مانند داکرفایلهای موجود اجرا کند.
docker-compose.yml
زیر را خارج از فولدر api
پاسخ شما قرار میدهد و با دستور docker-compose up --build
آن را اجرا میکند.docker-compose.yml
دلخواه نیستید.80
آدرس localhost
قابل دسترسی باشد.runner.sh
خود APIتان را روی 0.0.0.0:80
اجرا کنید.Dockerfile
امکان تغییر فایل Dockerfile
وجود ندارد، اما در اسکریپت runner.sh
میتوانید هر دستوری را اجرا کنید.
شما میتوانید تمامی محتوای موجود در پوشهی api
را تغییر دهید و هر فایلی که میخواهید اضافه یا کم کنید.
توجه کنید که نام فایل کد شما برای سیستم داوری اهمیتی ندارد و این خود شما هستید که در runner.sh
از نام آن برای اجرای پروژه استفاده میکنید.
در نهایت این پوشه را zip کرده و ارسال کنید. توجه کنید که پس از extract کردن فایل zip شما، باید پوشهی api
را ببینیم که درون آن Dockerfile
وجود دارد.