آموزش طراحی API Boot Kotlin Spring ابتدا با امنیت Spring

سرفصل ها و درس ها

مقدمه Introduction

• مقدمه Introduction

طراحی شمای پایگاه داده Database schema design

• با طرح واره پایگاه داده شروع کنید Start with the database schema

• طرح دیتابیس را تمام کنید Finish the database schema

پایگاه داده توسعه دهنده محلی خود را تنظیم کنید Set up your local dev database

• یک شبکه داکر و کانتینر جدید ایجاد کنید Create a new docker network and container

• پایگاه داده مواد غذایی را ایجاد کنید Create the groceries database

• خلاصه ای از آخرین دستورات Summary about the last commands

پروژه Kotlin Spring Boot را راه اندازی کنید Set up Kotlin Spring Boot project

• IDE خود را تنظیم کنید و به Postgres متصل شوید Set up your IDE & connect to Postgres

• برای .gitignore و بقیه پروژه متعهد شوید Commit for .gitignore and rest of project

• وابستگی ها در build.gradle.kts قسمت 1 Dependencies in build.gradle.kts Part 1

• وابستگی ها در build.gradle.kts قسمت 2 Dependencies in build.gradle.kts Part 2

• شروع به تنظیم فایل application.yml کنید Start to set up the application.yml file

• راه اندازی فایل application.yml را تمام کنید Finish set up of application.yml file

• ایجاد یک فایل .env محلی Creating a local .env file

• توضیحی در مورد سیاهه های بهار Explanation of the Spring Logs

• اولین تعامل با فایل open-api.yml First interaction with the open-api.yml file

• توضیح شاخه های پروژه Explaining the branches of the project

بسته خطا The error package

• کلاس خطای API The API error class

• شروع به پیاده سازی GlobalExceptionHandler کنید Start to implement GlobalExceptionHandler

• تمام کلاس های استثنای سفارشی را پیاده سازی کنید Implement all custom exception classes

• شروع به گروه بندی کلاس های استثنا کنید Start to group the exception classes

• بسته خطا را تمام کنید Finish error package

بسته کاربری The user package

• شروع به پیاده سازی موجودیت کاربر Start to implement user entity

• از رابط UserDetails ارث بری کنید Inherit from UserDetails interface

• رابطه یک به یک را برای رمز تأیید تنظیم کنید Set one to one relationship to verification token

• رابطه یک به چند را برای لیست خرید تنظیم کنید Set one to many relationship to shopping list

• مخزن کاربر را ایجاد کنید Create the user repository

• یک رابط برای سرویس کاربر ایجاد کنید Create an interface for the user service

• اولین نقطه پایانی خود را در YAML طراحی کنید Design your first endpoint in YAML

• اولین شی انتقال داده خود را در YAML طراحی کنید Design your first data transfer object in YAML

• سایر نقاط پایانی PATCH را در YAML برای منبع کاربر طراحی کنید Design other PATCH endpoints in YAML for user resource

• طراحی تمام نقاط پایانی و DTOها برای منبع کاربر را به پایان برسانید Finish designing all endpoints and DTOs for user resource

• ایجاد کد برای منابع کاربر و DTO Generate code for user resource and DTOs

• یک نگاشت برای یک موجودیت به DTO ایجاد کنید Create a mapper for an entity to DTO

• اجرای سرویس کاربر را شروع کنید Start implementation of user service

• کلاس پیکربندی احراز هویت را پیاده سازی کنید Implement the authentication config class

• یک رابط برای جلسه کاربر وارد شده تعریف کنید Define an interface for signed-in user session

• پیاده سازی منطق تغییر رمز عبور برای کاربر Implement change password logic for user

• اجرای سرویس کاربر را به پایان برسانید Finish implementation of user service

• پیاده سازی کنترل کننده کاربر Implement user controller

• کلاس های enum ایجاد کنید Generate enum classes

• شروع به تنظیم تست های یکپارچه سازی برای مخزن کاربر کنید Start to set up the integration tests for user repository

• اولین تست های یکپارچه سازی برای یافتن کاربر از طریق ایمیل First integration tests for finding user by email

• تست های یکپارچه سازی مخزن کاربر را تمام کنید Finish the integration tests for user repository

• تست واحد نقشه‌بردار کاربر User mapper unit test

• با افزودن فیلدهایی برای آزمایشات واحد خدمات کاربر شروع کنید Start with adding fields for user service unit tests

• تست واحد برای تغییر ایمیل کاربر Unit test for change user email

• تست واحد برای راه اندازی استثنا قالب ایمیل نامعتبر Unit test for trigger invalid email format exception

• تست های واحد بیشتر برای استثنای درخواست بد در مورد ایمیل More unit tests for bad request exception regarding email

• تست واحد برای تغییر رمز عبور کاربر Unit test for change user password

• راه اندازی تست های استثنا عدم تطابق رمز عبور Triggering password mismatch exception tests

• پایان تست واحد برای سرویس کاربر Finish unit tests for user service

پکیج احراز هویت The auth package

• مخزن رمز تأیید را ایجاد کنید Create the repository for verification token

• اجرای سرویس جلسه مشتری Implement client session service

• کلید مخفی JWT را ایجاد کنید Generate JWT secret key

• پیاده سازی منطق برای تولید کلیدهای JWT Implement logic for generating JWT keys

• نام کاربری را از توکن JWT استخراج کنید Extract username from JWT token

• اجرای سرویس JWT را به پایان برسانید Finish implementing JWT service

• راه اندازی سرویس SMTP با Brevo Setup SMTP service with Brevo

• اجرای سرویس ایمیل را شروع کنید Start implementing email service

• پیاده سازی منطق برای ارسال ایمیل Implement logic for send emails

• اجرای سرویس ایمیل را به پایان برسانید Finish implementation of email service

• شروع به تعریف نقاط پایانی auth کنید Start to define auth endpoints

• اولین DTO ها را برای نقاط پایانی auth تعریف کنید Define first DTOs for auth endpoints

• تعیین نقاط پایانی کاربر و ورود به سیستم Define verify user and sign-in endpoints

• تعریف نقاط پایانی auth را تمام کنید Finish defining auth endpoints

• ایجاد mapper برای درخواست ثبت نام به نهاد کاربر Create mapper for register request to user entity

• اجرای سرویس مدیریت حساب را شروع کنید Start implementing account management service

• اجرای ثبت نام کاربر Implement user sign-up

• اجرای تایید کاربر Implement verify user

• پیاده سازی ورود به سیستم کاربر Implement sign-in user

• پیاده سازی مجدد رمز عبور کاربر Implement reset user password

• اجرای فیلتر برای JWT را شروع کنید Start implementing the filter for JWT

• فیلتر درخواست اول را اجرا کنید Implement first request filter

• کنترل کننده احراز هویت The auth controller

• شروع به پیاده سازی تنظیمات امنیتی برای API کنید Start implementing the security config for the API

• اجرای پیکربندی امنیتی برای API را به پایان برسانید Finish implementing security config for API

• رفع اشکال فیلتر JWT Fix JWT filter bug

• آزمایش نقاط پایانی را با Postman شروع کنید Start testing endpoints with Postman

• نقاط پایانی باقیمانده را در Postman تست کنید Test remaining endpoints in Postman

• تست ادغام برای مخزن رمز تأیید Integration test for verification token repo

• تست واحد برای نقشه‌بردار ثبت‌نام Unit test for sign-up mapper

• تست های واحد برای ایجاد کلید JWT Unit tests for JWT key creation

• آماده شدن برای نوشتن تست های واحد برای خدمات مدیریت حساب Preparing to write unit tests for account management service

• تست واحد برای ثبت نام موفقیت آمیز کاربر Unit test for successful user sign-up

• تست های واحد برای استثناهای ثبت نام Unit tests for sign-up exceptions

• تست واحد تأیید کاربر برای مورد موفقیت Unit test verify user for success case

• تست واحد موارد استثنای کاربر را تأیید می کند Unit test verify user exception cases

• تأیید آزمایش واحد برای رمز تأیید منقضی شده Unit test verify for expired verification token

• ورود به سیستم تست واحد برای پاسخ احراز هویت Unit test sign-in for authentication response

• موارد استثنای ورود به سیستم تست واحد Unit test sign-in exceptions cases

• واحد برای بازنشانی رمز عبور آزمایش می کند Unit tests for reset password

• کلاس تست خدمات جلسه مشتری را راه اندازی کنید Set up client session service test class

• آزمون های واحد برای روش های جلسات مشتری برای موارد موفقیت Unit tests for client sessions methods for the success cases

• آزمون های واحد برای روش های جلسات مشتری برای موارد استثنا Unit tests for client sessions methods for the exception cases

• تست های واحد را برای سرویس ایمیل شروع کنید Start unit tests for email service

• تست های واحد را برای سرویس ایمیل به پایان برسانید Finish unit tests for email service

• کلاس تست سرویس jwt را راه اندازی کنید Set up the jwt service test class

• اولین تست واحد برای سرویس jwt First unit test for jwt service

• تست واحد برای حالت استثنا و منطق معتبر کلاس سرویس jwt است Unit test for exception case and is token valid logic of jwt service class

• تست های واحد را برای سرویس jwt به پایان برسانید Finish unit tests for jwt service

• بهبود تست های واحد برای سرویس ایمیل Improve unit tests for email service

• تست ادغام را برای کنترل کننده احراز هویت تنظیم کنید Set up integration test for authentication controller

• تست یکپارچه سازی برای نقطه پایانی ثبت نام Integration test for sign-up endpoint

• پایان تست های یکپارچه سازی برای کنترل کننده احراز هویت Finish integration tests for authentication controller

• شروع به تنظیم تست های یکپارچه سازی برای کنترل کننده کاربر Start to setup integration tests for user controller

• تست یکپارچه سازی برای تغییر نقطه پایانی ایمیل برای کنترل کننده کاربر Integration test for change email endpoint for user controller

• تست های یکپارچه سازی بیشتر برای نقاط پایانی کنترل کننده کاربر More integration tests for user controller endpoints

• پایان تست های ادغام برای کنترل کننده کاربر Finish integrations tests for user controller

بسته پیکربندی The config package

• توضیح مختصری در مورد بسته کانفیگ Short explanation of the config package

بسته خرده فروشی The retail package

• شروع به طراحی نقاط پایانی لیست خرید کنید Start to design the endpoints for shopping list

• شروع به تعریف DTO برای نقاط پایانی لیست خرید کنید Start to define DTOs for shopping list endpoints

• DTO های بیشتری برای تعریف More DTOs to define

• DTO های بیشتری را برای آیتم های لیست خرید و سوپرمارکت تعریف کنید Define more DTOs for shopping list item and supermarket

• نقاط پایانی جدیدی برای واکشی و حذف یک لیست خرید خاص تعریف کنید Define new endpoints for fetching and deleting a specific shopping list

• نقطه پایانی پچ را برای لیست خرید با شناسه به اضافه DTOها تعریف کنید Define patch endpoint for shopping list by id plus the DTOs

• یک نقطه پایانی جدید برای درخواست های GET و POST برای آیتم های لیست تعریف کنید Define a new endpoint for GET and POST requests for list items

• یک نقطه پایانی جدید برای GET و DELETE و PATCH برای یک آیتم لیست خاص تعریف کنید Define a new endpoint for GET and DELETE and PATCH for a specific list item

• DTO ها را برای به روز رسانی یک آیتم لیست تعریف کنید Define the DTOs for updating a list item

• دو نقطه پایانی دیگر برای اقلام مواد غذایی تعریف کنید Define two more endpoints for grocery item

• موجودیت جدید ایجاد کنید و موجود را اصلاح کنید Create new entity and modify existing one

• موجودیت های باقی مانده را ایجاد کنید Create remaining entities

• اجرای سوپرمارکت حمل و نقل مرتبط با منطق تجاری Implement business logic related handling supermarket

• شروع به پیاده سازی منطق تجاری برای اقلام مواد غذایی کنید Start to implement business logic for grocery item

• اجرای منطق خدمات اقلام مواد غذایی را به پایان برسانید Finish implementing the logic for grocery item service

• مخزن و نقشه‌بردار برای آیتم فهرست خرید ایجاد کنید Create repo and mapper for shopping list item

• شروع به اجرای سرویس آیتم لیست خرید کنید Start to implement shopping list item service

• اجرای سرویس آیتم لیست خرید را تمام کنید Finish implementing the shopping list item service

• پیاده سازی مخزن و نقشه برداری برای لیست خرید Implement repository and mapper for shopping list

• روش های خدمات لیست خرید را تعریف کنید Define the methods for shopping list service

• شروع به اجرای سرویس لیست خرید کنید Start to implement shopping list service

• اجرای روش های کمکی برای خدمات لیست خرید را به پایان برسانید Finish implementing helper methods for shopping list service

• پیاده سازی روش هایی برای ایجاد و واکشی یک لیست خرید خاص Implement methods for creating and fetching a specific shopping list

• روش دریافت لیست خرید را پیاده سازی کنید Implement get shopping lists method

• روش های به روز رسانی و حذف را برای سرویس لیست خرید پیاده سازی کنید Implement update and delete methods for shopping list service

• روش‌هایی را برای اقلام مواد غذایی و فهرست خرید پیاده‌سازی کنید Implement methods for grocery item and shopping list item

• اجرای سرویس لیست خرید را تمام کنید Finish implementing shopping list service

• کنترل کننده اقلام مواد غذایی را پیاده سازی کنید Implement the grocery item controller

• پیاده سازی کنترل کننده آیتم لیست خرید Implement shopping list item controller

• رفع خطا در کنترلر آیتم لیست خرید Fix error in shopping list item controller

• پیاده سازی کنترل لیست خرید Implement shopping list controller

• تست های یکپارچه سازی برای مخزن اقلام مواد غذایی Integration Tests for grocery item repository

• تست های یکپارچه سازی برای مخزن سوپرمارکت Integration Tests for supermarket repository

• تست های یکپارچه سازی برای آیتم لیست خرید Integration Tests for shopping list item

• کلاس راه اندازی برای تست های یکپارچه سازی مخزن لیست خرید Setup class for shopping list repository integration tests

• اولین تست های یکپارچه سازی را برای مخزن لیست خرید بنویسید Write the first integration tests for shopping list repository

• پایان تست های یکپارچه سازی برای مخزن لیست خرید Finish integration tests for shopping list repository

• آزمایشات واحد برای نقشه‌بردار اقلام مواد غذایی Unit Tests for grocery item mapper

• تست‌های واحد را برای کلاس‌های نقشه‌بردار باقی‌مانده به پایان برسانید Finish unit tests for remaining mapper classes

• تست واحد برای خدمات سوپرمارکت Unit Tests for supermarket service

• با آزمایش واحد برای خدمات اقلام خواربارفروشی شروع کنید Start with unit tests for grocery item service

• تست های واحد بیشتر برای خدمات اقلام خواربارفروشی More unit tests for grocery item service

• آزمایشات واحد را برای سرویس اقلام مواد غذایی به پایان برسانید Finish unit tests for grocery item service

• شروع به نوشتن تست های واحد برای خدمات لیست خرید کنید Start writing unit tests for shopping list item service

• تست های واحد برای حذف اقلام لیست در سرویس اقلام لیست خرید Unit Tests for deleting list items in shopping list item service

• تست واحد برای ایجاد یک آیتم لیست در سرویس آیتم لیست خرید Unit Test for creating a list item in shopping list item service

• تست های واحد را برای سرویس آیتم لیست خرید به پایان برسانید Finish unit tests for shopping list item service

• راه اندازی سرویس لیست خرید را شروع کنید Start setting up shopping list service

• تست واحد اول خدمات لیست خرید First unit test for shopping list service

• استثنا تست واحد برای ایجاد لیست خرید و واکشی لیست خرید Unit Test exception for creating a shopping list and fetching a shopping list

• تست های واحد برای واکشی لیست های خرید منفرد و چندگانه Unit Tests for fetching a single and multiple shopping lists

• تست های واحد را برای واکشی چند لیست خرید نهایی کنید Finalise unit tests for fetching multiple shopping lists

• شروع آزمایش واحد با به روز رسانی لیست خرید Start unit testing updating a shopping list

• واحد تست به روز رسانی و حذف لیست خرید Unit Test update and delete shopping list

• آزمایش واحد در حال واکشی یک کالای خواربار در سرویس فهرست خرید Unit Test fetching a single grocery item in shopping list service

• تست واحد در حال به‌روزرسانی یک کالای خواربار و واکشی اقلام فهرست در سرویس فهرست خرید Unit Test updating a grocery item and fetch list items in shopping list service

• واحد تست برای دریافت آیتم لیست خرید Unit Tests for get shopping list item

• واحد تست ایجاد پاسخ آیتم لیست خرید Unit Test create shopping list item response

• تست واحد برای حذف آیتم لیست در سرویس لیست خرید Unit Tests for deleting list item in shopping list service

• تست های واحد را در سرویس لیست خرید نهایی کنید Finalise unit tests in shopping list service

• تست یکپارچه سازی راه اندازی برای کنترل کننده اقلام مواد غذایی Setup integration test for grocery item controller

• اولین تست یکپارچه سازی برای به روز رسانی اقلام مواد غذایی First integration test for update grocery item

• پایان تست های یکپارچه سازی برای کنترل کننده اقلام مواد غذایی Finish integration tests for grocery item controller

• با اولین تست یکپارچه سازی برای کنترل کننده آیتم لیست خرید شروع کنید Start with the first integration test for shopping list item controller

• تست های یکپارچه سازی برای حذف و واکشی آیتم لیست خاص Integration tests for delete and fetch specific list item

• پایان تست های یکپارچه سازی برای کنترلر آیتم لیست خرید Finish integration tests for shopping list item controller

• شروع به نوشتن اولین تست یکپارچه سازی برای کنترل کننده لیست خرید کنید Start writing first integration test for shopping list controller

• تست های یکپارچه سازی برای حذف و واکشی یک لیست خرید خاص Integration Tests for deleting and fetching a specific shopping list

• تست های یکپارچه سازی را برای کنترل کننده لیست خرید نهایی کنید Finalise integration tests for shopping list controller

تست نقاط پایانی در Postman Testing endpoints in Postman

• ورودی های سوپرمارکت را در پایگاه داده وارد کنید Insert supermarket entries into database

• مجموعه جدید Postman را ایجاد کنید Generate new Postman collection

• نقاط پایانی grocery-item-resource را به صورت دستی آزمایش کنید Manually test the grocery-item-resource endpoints

• نقاط پایانی لیست آیتم-منبع خرید را به صورت دستی آزمایش کنید Manually test the shopping-list-item-resource endpoints

• نقاط پایانی فهرست منابع خرید را به صورت دستی آزمایش کنید Manually test the shopping-list-resource endpoints

Outro Outro

• خلاصه و ایده های بهبود Summary and improvement ideas