Skip to content

dugersuren-exe/irts

BranchesTags

Repository files navigation

API апп боловсруулах

API боловсруулах хичээлийг ирц бүртгэлийн project угсрахдаа тайлбарлаад явъя.

Энэхүү project-ийг гүйцэтгэхдээ дараах алхамуудыг хэрэгжүүлэх хэрэгтэй

1. Орчиноо бэлдэх

Project-ийг угсрахын тулд эхлээд орчиноо бүрдүүлсэн байх шаардлагатай. php 8.1.10, mysql, git, commposer зэргийг ашиглахаар сонгож авсан.

Эдгээрийн хувилбарыг дараах командын тусламжтайгаар шалгаж болно.

php-ийн хувилбар

php --version

composer-ийн хувилбарыг шалгах

composer --version

git-ийн хувилбарыг шалгах

git --version

Мөн нэмэлэт байдлаар Laragon-ийг суулган ашиглаж болно.

Laragon-ийг суулгасан тохиолдолд php, composer, mysql гэх мэт програм хангамжууд нь давхар суулгагддаг.

Харин түүнийг Virtual Environment дээр тохиргоо хийж public байдлаар ашиглах боломжийг бүрдүүлэх хэрэгтэй.

2. Project-оо үүсгэх

Фолдер бэлдэх

Ер нь аливаа project-ийг үүсгэхдээ өөрийн Фолдер дотроо үүсгэж байх хэрэгтэй.

Одоо бид жишээ болгон өөрийн project-үүдийг үүсгэх apps нэртэй фолдер дотроо irts нэртэй project үүсгэе. Үүний тулд cmd-ийг ашиглан тухайн apps нэртэй фолдер дотроо очсон байх ёстой.

фолдероо солихдоо cd дараах командыг ашиглаж болно.

cd apps

Project үүсгэх команд

composer create-project laravel/laravel irts

Тухайн project-оо ажиллуулж үзэх. Үүний тулд irts нэртэй фолдер дотроо шилжсэн байх ёстой.

Мөн VSCode ашиглаж байгаа бол тухайн irts нэртэй фолдерийг нээх ёстой. Гадна талын фолдер эсвэл дотор талын фолдерийг нээсэн тохиолдолд ажиллахгүй байх магадлалтай.

php artisan serve
3. Өгөгдлийн баазтай холбох

Project-ийг өгөгдлийн баазтай холбохын тулд:

  1. mySql -ийг суулгасан байх ёстой бөгөөд mySql нь хэвийн ажиллаж байх ёстой.
  2. .env файл дээр тохиргоо хийж өгөх ёстой.

Жишээ нь

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=irts
DB_USERNAME=root
DB_PASSWORD=

Энэ хэсэгт Mysql -тэй холбогдох тохиргоог хийж хадгална.

4. Authentication-ийг удирдах боломжийг бүрдүүлэх

Нэвтрэх, хамгаалалтын нэмэл санг суулгах

composer require laravel/breeze --dev

Прожект-д цаанаасаа бичигдсэн кодыг нэмж өгөх

php artisan breeze:install
5. Модел болон migration-ийг үүсгэх

Migration нь өгөгдлийн баазад үүсгэх хүснэгт болон тэдгээрийн хоорондын relationship холболтыг зохион байгуулах боломжийг олгодог.

Мөн Relationship холболтыг удирдахын тулд Migration файлыг үүсгэх дараалал нь маш чухал байдаг. Иймд бид дараах байдлаар ажиллуулъя.

php artisan make:model Stat
php artisan make:model Teacher
php artisan make:model Course 
php artisan make:model Student 
php artisan make:model Attendance

Мөн migration-ийг үүсгэхдээ тухайн migration-ий Модел -ийг нь хамтад нь үүсгэх боломжтой байдаг.

Тэгэхээр бид дээрх кодыг ажиллуулахгүйгээр хамтад нь дараах кодын тусламжтайгаар үүсгээд явъя.

php artisan make:model Stat -m
php artisan make:model Teacher -m
php artisan make:model Course -m
php artisan make:model Student -m
php artisan make:model Attendance -m

Дээрх командыг ажиллуулснаар Stat, Teacher, Course, Student, Attendance -ийн тус бүр migration болон Model-ийн нийт 10 файл үүснэ.

Эхлээд бид Migration файлтай ажиллана. Дараа нь бид үүссэн Model-уудтай ажиллана.

6. Хүснэгт бүрийн талбаруудыг зааж өгөх, үүсгэх

Үүссэн Migration файлд хүснэгтийн багануудыг зааж өгнө.

Stat migration

    $table->id();
    $table->string('name');
    $table->string('abr');

Teacher migration

    $table->id();
    $table->string('firstName');
    $table->string('lastName');
    $table->string('gender');
    $table->string('phoneNumber');
    $table->string('lesson');

Course migration

    $table->id();
    $table->unsignedBigInteger('teacher_id')->index();
    $table->integer('grade');
    $table->string('group');
    $table->string('YearLesson');
    $table->boolean('isActive');
    

    $table->foreign('teacher_id')->references('id')->on('teachers')->cascadeOnDelete();

Student migration

    $table->id();
    $table->unsignedBigInteger('course_id')->index();
    $table->string('firstName');
    $table->string('lastName');
    $table->string('gender');
    $table->string('phoneNumber');
    $table->string('RD');
    $table->boolean('isActive');


    $table->foreign('course_id')->references('id')->on('courses')->cascadeOnDelete();

Attendance migration

    $table->id();
    $table->unsignedBigInteger('course_id')->index();
    $table->unsignedBigInteger('student_id')->index();
    $table->unsignedBigInteger('stat_id')->index();
    $table->date('adate');
    $table->timestamps();


    $table->foreign('course_id')->references('id')->on('courses')->cascadeOnDelete();
    $table->foreign('student_id')->references('id')->on('students')->cascadeOnDelete();
    $table->foreign('stat_id')->references('id')->on('stats')->cascadeOnDelete();

Migration файлд бичигдсэн командын тусламжтайгаар өгөгдлийн бааз (mysql) руу хүснэгтүүдийг үүсгэхдээ дараах командыг ашиглна.

Баазад өмнө нь хүснэгт үүсээгүй байгаа бол migration -ийн тусламжтайгаар хүснэгт үүсгэхдээ дараах командыг ашиглаж болно.

php artisan migrate

Хэрвээ хуучин хүснэгтүүдээ устгаж шинээр үүсгэхдээ дараах командыг ашиглаж болно.

php artisan migrate:refresh

Анхаар!!!

migration хийх үед алдаа гарсан бол дараах командуудын тусламжтайгаар засварлаж болно.

composer dump-autoload

Migration хийсэн үйлдлийг буцаах үүрэгтэй

php artisan migrate:rollback

Сүүлийн k ш migration үйлдлийг буцаах

php artisan migrate:rollback --step=5

Бусад хэлбэрүүд

php artisan migrate:rollback --pretend
php artisan migrate:reset
7. Seeder-тэй ажиллах

Seeder нь өгөгдлийн бааз руу өгөгдсөн загвар дата-г оруулах үүрэгтэй байдаг. Энэхүү загвар өгөгдлийг оруулахдаа эхлээд Seeder файлыг үүсгэх ёстой бөгөөд дотор нь өгөгдлүүдээ оруулж хадгалсан байх ёстой.

Seeder файлыг үүсгэх

Seeder файлуудыг дараах командын тусламжтайгаар үүсгэнэ.

php artisan make:seeder StatSeeder
php artisan make:seeder TeacherSeeder
php artisan make:seeder CourseSeeder

php artisan make:seeder StudentSeeder
php artisan make:seeder AttendanceSeeder

Үүссэн файлд хүснэгтэд оруулах өгөгдлийг бичиж хадгалах ёстой.

Жишээ болгон Stat, Teacher, Course Seeder-ийн кодыг авч үзье.

<?php

namespace Database\Seeders;

use Illuminate\Database\Console\Seeds\WithoutModelEvents;
use Illuminate\Database\Seeder;
use DB;
class StatSeeder extends Seeder
{
    /**
     * Run the database seeds.
     */
    public function run(): void
    {
        DB::table('stats')->delete();
        $datas = [
            ['id' => 1, 'name' => 'Ирсэн', 'abr' => 'и'],
            ['id' => 2, 'name' => 'Чөлөөтэй', 'abr' => 'ч'],
            ['id' => 3, 'name' => 'Өвчтэй', 'abr' => 'ө'],
            ['id' => 4, 'name' => 'Тасалсан', 'abr' => 'т'],
        ];
        DB::table('stats')->insert($datas);
    }
}

Анхаарах зүйл!!!

DB -ийг ашиглаж байгаа учир DB-ийг Seeder файл дотор import хийж оруулах ёстой.

use DB;

Үүнтэй ижил зарчимаар Teacher болон Course-ийг өгөгдлийг бичнэ. Жишээ болнон гол хэсгийг авч үзье.

TeacherSeeder

TeacherSeeder-д нэмэх кодыг доор харуулав. Мөн энэ файлд use DB; -ийг мөн нэмэх ёстой гэдгийг анхаарах хэрэгтэй.

        DB::table('teachers')->delete();
        $datas = [
            ['id' => 20200101, 'firstName' => 'Дүгэрсүрэн', 'lastName' => 'Б', 'gender' => 'эрэгтэй', 'phoneNumber' => '999', 'lesson' => 'Мэдээлэлзүй'],
            ['id' => 20200102, 'firstName' => 'Баасандорж', 'lastName' => 'Б', 'gender' => 'эрэгтэй', 'phoneNumber' => '8888', 'lesson' => 'Мэдээлэлзүй'],
            ['id' => 20200103, 'firstName' => 'Мөнхбаяр', 'lastName' => 'Б', 'gender' => 'эрэгтэй', 'phoneNumber' => '999', 'lesson' => 'Мэдээлэлзүй'],
            ['id' => 20200104, 'firstName' => 'Ариунсарнай', 'lastName' => 'Б', 'gender' => 'эрэгтэй', 'phoneNumber' => '8888', 'lesson' => 'Мэдээлэлзүй'],
            ['id' => 20200105, 'firstName' => 'Сайнбуян', 'lastName' => 'Б', 'gender' => 'эрэгтэй', 'phoneNumber' => '999', 'lesson' => 'Мэдээлэлзүй'],
            ['id' => 20200106, 'firstName' => 'Хулан', 'lastName' => 'Б', 'gender' => 'эрэгтэй', 'phoneNumber' => '8888', 'lesson' => 'Монгол хэл'],
            ['id' => 20200107, 'firstName' => 'Буяндэлгэр', 'lastName' => 'Б', 'gender' => 'эрэгтэй', 'phoneNumber' => '8888', 'lesson' => 'Монгол хэл'],
        ];
        DB::table('teachers')->insert($datas);

CourseSeeder

CourseSeeder-д нэмэх кодыг доор харуулав. Мөн энэ файлд use DB; -ийг мөн нэмэх ёстой гэдгийг анхаарах хэрэгтэй.

        DB::table('courses')->delete();
        $datas = [
            ['id' => 1, 'teacher_id' => 20200101,'grade' => 12 , 'group' => 'А', 'YearLesson' => '2024-2025', 'isActive' => true],
            ['id' => 2, 'teacher_id' => 20200102,'grade' => 11 , 'group' => 'А', 'YearLesson' => '2024-2025', 'isActive' => true],
            ['id' => 3, 'teacher_id' => 20200103,'grade' => 10 , 'group' => 'А', 'YearLesson' => '2024-2025', 'isActive' => true],
            ['id' => 4, 'teacher_id' => 20200104,'grade' => 9 , 'group' => 'А', 'YearLesson' => '2024-2025', 'isActive' => true],
            ['id' => 5, 'teacher_id' => 20200105,'grade' => 8 , 'group' => 'А', 'YearLesson' => '2024-2025', 'isActive' => true],
            ['id' => 6, 'teacher_id' => 20200106,'grade' => 7, 'group' => 'А', 'YearLesson' => '2024-2025', 'isActive' => true],
            ['id' => 7, 'teacher_id' => 20200107,'grade' => 7 , 'group' => 'Б', 'YearLesson' => '2024-2025', 'isActive' => true],
        ];
        DB::table('courses')->insert($datas);

Энд бичигдсэн өгөгдлийн дангаар нь ажиллуулахдаа дараах командыг өгөх хэрэгтэй болдог.

StatSeeder-ийг ажиллуулж Stat хүснэгтэд өгөгдлүүдийг оруулахдаа дараах команыг ашиглана.

php artisan db:seed --class=StatSeeder

TeacherSeeder-ийг ажиллуулж Teacher хүснэгтэд өгөгдлүүдийг оруулахдаа дараах команыг ашиглана.

php artisan db:seed --class=TeacherSeeder

CourseSeeder-ийг ажиллуулж Course хүснэгтэд өгөгдлүүдийг оруулахдаа дараах команыг ашиглана.

php artisan db:seed --class=CoursetSeeder

Даалгавар 1

Таны даалгавар бол үлдсэн StudentSeeder, AttendanceSeeder гэсэн 2 Seeder-ийг үүсгэж оруулах тогтмол өгөгдлийг нэмж ажиллуулах

Seeder -үүдийг нэгтгэх

Seeder бүрийн кодыг тус бүрд нь ажиллуулахгүйгээр нэг Seeder дуудаж бүгдийг нь зэрэг ажиллуулах боломжтой байдаг. Үүний тулд уг Seeder файлуудыг DatabaseSeeder дотор бичиж өгөөд дуудах боломжтой байдаг. Ийм кодыг авч үзье.

Жишээ болгон StatSeeder-ийн кодыг оруулж байна.

DatabaseSeeder файл дотрох код

<?php

namespace Database\Seeders;

// use Illuminate\Database\Console\Seeds\WithoutModelEvents;
use Illuminate\Database\Seeder;

class DatabaseSeeder extends Seeder
{
    /**
     * Seed the application's database.
     */
    public function run(): void
    {
        // call All seeder 
        $this->call([
            StatSeeder::class,
            TeacherSeeder::class,
            CourseSeeder::class,
        ]);        
    }
}

Уг кодыг бичсний дараар дараах нэг командын тусламжтайгаар 3 seeder файлын өгөгдлийн нэг дор оруулах боломжой болж байна.

php artisan db:seed

Даалгавар 2

Та нэмэлтээр бичсэн 2 Seeder файлаа мөн энд байгаа DatabaseSeeder файлд нэмж оруулан дуудах боломжийг бүрдүүлэх. Дараа нь нэг дуудалтаар ажиллаж байгаа эсэхийг шалгаж үзээрэй.

Нэмэлт мэдээлэл

Мөн DatabaseSeeder файлыг үүсгэчихсэн тохиолдодл өгөгдлийн бааз руу хүснэгтийг үүсгэчихээд DatabaseSeeder файлыг мөн давхар ажиллуулахдаа дараах командыг ажиллуулж болно.

php artisan migrate:refresh --seed
8. Factory -ийг үүсгэх

Facroty команд нь тэст хийхэд зориулагдсан бөгөөд өгөгдлийн сан дахь тухайн хүснэгт рүү санамсаргүйгээр олон тооны өгөгдлийг үүсгэж оруулах боломжийг олгож өгдөг.

Тэгэхээр олон өгөгдөл оруулан тест хийх шаардлагатай өгөгдөл дээр ашиглавал илүү тохиромжтой байдаг. Жишээ нь Stat хүснэгт нь олон тооны өгөгдөл оруулах шаардлагагүй учир StatSeeder-ийн тусламжтайгаар өгөгдлүүдээ оруулж өгөх нь тохиромжтой.

Харин Course хүснэгт ч гэсэн CourseSeeder-ийн тусламжтайгаар өгөгдлүүдээ оруулж болох юм. Гэсэн хэдий ч бид Seeder болон Factory гэсэн 2 хэлбэрээр тестлэх дата-г оруулсан ч болно. Иймд туршилт байдлаар CourseFactory-ийг үүсгэж туршиж үзье.

CourseFactory-ийг үүсгэхдээ дараах командыг өгдөг.

php artisan make:factory CourseFactory

Үүсгэсэн CourseFactory дотроо хүснэгт рүү санамсаргүйгээр оруулах утгуудыг тодорхойлж өгөх.

жишээ нь:

<?php

namespace Database\Factories;

use Illuminate\Database\Eloquent\Factories\Factory;

/**
 * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\Course>
 */
class CourseFactory extends Factory
{
    /**
     * Define the model's default state.
     *
     * @return array<string, mixed>
     */
    public function definition(): array
    {
        return [
            'teacher_id' => $this->faker->numberBetween($min=20200101, $max=20200107),
            'grade' => $this->faker->numberBetween($min=1, $max=13),
            'group' => $this->faker->randomElement(['А', 'Б', 'В', 'Г', 'Д', 'Е', 'Ё', 'Ж', 'З']),
            'YearLesson' =>$this->faker->randomElement(['2023-2024', '2022-2023', '2021-2022', '2020-2021']),// $this->faker->sentence(1),
            'isActive' => $this->faker->boolean(),
        ];
    }
}

Үүний дараа өгөгдлөө санамсаргүйгээр үүсгэхдээ DatabaseSeeder дотор дуудаж өгөх шаардлагатай байдаг.

Дуудасхдаа дараах кодын тусламжтайгаар дуудаж ажиллуулна.

\App\Models\Course::factory(10)->create();

Дээрх дуудаж байгаа команд нь Course руу санамсаргүй 10 мөр өгөгдөл үүсгэ гэсэн команд юм.

Үүнтэй ижилээр StudentFactory-ийг үүсгэж болох юм.

Тэгвэл дараах командаар StudentFactory файлаа үүсгэх ёстой.

php artisan make:factory StudentFactory

Тухайн StudentFactory дотор санамсаргүйгээр өгөгдөл үүсгэх кодыг бичиж өгнө.

Энд жишээ болгон StudentFactory дотор нэмж бичих гол кодын загварыг оруулж өгвөл.

        return [
            'course_id' => $this->faker->numberBetween($min=1, $max=7),
            'firstName' => fake()->name(),
            'lastName' => fake()->name(),
            'gender' =>$this->faker->randomElement(['эрэгтэй', 'эмэгтэй']),
            'phoneNumber' => fake()->name(),
            'RD' =>fake()->name(),
            'isActive' => $this->faker->boolean(),
        ];

Үүнийг мөн DatabaseSeeder дотор дуудаж ажиллуулдаг. Өмнөх код дээр нэмж бичвэл

\App\Models\Course::factory(10)->create();
\App\Models\Student::factory(150)->create();

Дээрх код нь Student хүснэгт рүү 150 мөр өгөгдлийг санамсаргүйгээр оруулна гэсэн үг юм.

Уг кодыг бичсний дараар дараах нэг командын тусламжтайгаар 3 seeder болон 2 Factory-ийг бүгдийг нь ажиллуулахдаа дараах командын тусламжтайгаар дуудаж ажиллуулна.

php artisan db:seed
9. Model-ийн тохиргоо хийх

Модел дээр relationship холболт болон нэмэл функцүүдийг бичиж өгснөөр Controller болон Resourse дотор түүнийг дуудан ашиглах, хэрэгцээт өгөгдлүүдээ дуудах боломжтой болно.

Жишээ болнон бид өөрсдийн Model дээр бичигдэх кодыг оруулъя.

Stat model

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Stat extends Model
{
    use HasFactory;
    protected $guarded=[];
    public $timestamp=false;
 
    public function attendances(){
        return $this->hasMany(Attendance::class,'stat_id');
    }

}

  1. Дээрх кодонд байгаа protected $guarded=[]; нь migration дотор тодорхойлогдсон бүх баганыг бүгдийг нь авна гэсэн үг болж байна.

  2. Мөн дээрк кодонд public $timestamp=false; гэсэн утга нь StatMigration дотор timestampt талбар байхгүй байгааг илэрхийлж байна.

  3. Дээрх кодонд байгаа

    public function attendances(){ return $this->hasMany(Attendance::class,'stat_id'); }

    гэсэн код нь Stat хүснэгт нь гадагш нэгээс олон гэсэн холбоосоор Attendence хүснэгт рүү холбогдоно гэдгийг илэрхийлж байна

Мөн дээрх кодонд өгөгдсөн зарчимаар Teacher model-ийг үүсгэвэл дараах байдлаар бичигдэнэ.

Teacher model

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Teacher extends Model
{
    use HasFactory;
    protected $guarded=[];
    public $timestamp=false;

    public function courses(){
        return $this->hasMany(Course::class,'teacher_id');
    }

}

Энэхүү код нь өмнөхтэй ижил агуулгатай юм.

Одоо арай ялгаатай нэг Course model-ийг авч үзье. Бичигдэх кодыг доор харуулав.

Course model

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Course extends Model
{
    use HasFactory;
    protected $guarded=[];
 
    public function teacher(){
        return $this->belongsTo(Teacher::class,'teacher_id');
    }
 
    public function students(){
        return $this->hasMany(Student::class,'course_id');
    }
 
    public function attendances(){
        return $this->hasMany(Attendance::class,'course_id');
    }
}

Дээрх кодонд ялгаатай бичигдэж байгаа зүйл нь

public function teacher(){ return $this->belongsTo(Teacher::class,'teacher_id'); } бөгөөд энэ нь тухайн Course хүснэгт нь Teacher хүснэгттэй Олоноос нэг гэсэн холбоосоор холбогдсоныг харуулж байна.

Ийм байдлаар дараах Model-уудыг үүсгэж болох юм.

Student model

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Student extends Model
{
    use HasFactory;
    protected $guarded=[];

    public function course(){
        return $this->belongsTo(Course::class,'course_id');
    }
 
    public function attendances(){
        return $this->hasMany(Attendance::class,'student_id');
    }
}

Attendance model

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Attendance extends Model
{
    use HasFactory;
    protected $guarded=[];
    public $timestamps = false;
    public function course(){
        return $this->belongsTo(Course::class,'course_id');
    }

    public function student(){
        return $this->belongsTo(Student::class,'student_id');
    }

    public function stat(){
        return $this->belongsTo(Stat::class,'stat_id');
    }
 
    
}
10. Controller үүсгэх

Controller файлыг дараах командын тусламжтайгаар үүсгэдэг.

php artisan make:controller StatController 
php artisan make:controller StudentController 
php artisan make:controller TeacherController 
php artisan make:controller CourseController
php artisan make:controller AttendanceController

Энэ команд нь зөвхөн Controller файлыг хоосон үүсгэдэг.

Жишээ нь:

php artisan make:controller StatController

Дээрх командыг өгөхөд дараах код үүснэ.

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class StatusController extends Controller
{
    //
}

Энэхүү кодонд бид өөрсдөө хэрэгтэй функцүүдээ бичиж өгч ашиглах хэрэгтэй болдог.

Үүнээс гадна Controller дотор байж болох хоосон функцүүдийг мөн нэмэлтээр оруулан үүсгүүлж болдог. Ингэж үүсгэхийн тулд дээрх командын оронд дараах байдлаар бичиж өгч болно.

АНХААР

Дээрх командын тусламжтайгаар үүсгэхийн оронд доор бичигдсэн кодыг ашиглаж болно. Ингэснээр тодорхой функцүүдтэй үүсэх боломжтой.

php artisan make:controller StatController --resource
php artisan make:controller StudentController --resource
php artisan make:controller TeacherController --resource
php artisan make:controller CourseController --resource
php artisan make:controller AttendanceController --resource

Харин бид загвар функцтэй байдлаар Controller-ийг үүсгэх жишээг туршиж үзье. Жишээ нь:

php artisan make:controller StatController --resource

Дээрх командын тусламжтайгаар дараах код бүхий файл үүснэ.

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class StatusController extends Controller
{
    /**
     * Display a listing of the resource.
     */
    public function index()
    {
        //
    }

    /**
     * Show the form for creating a new resource.
     */
    public function create()
    {
        //
    }

    /**
     * Store a newly created resource in storage.
     */
    public function store(Request $request)
    {
        //
    }

    /**
     * Display the specified resource.
     */
    public function show(string $id)
    {
        //
    }

    /**
     * Show the form for editing the specified resource.
     */
    public function edit(string $id)
    {
        //
    }

    /**
     * Update the specified resource in storage.
     */
    public function update(Request $request, string $id)
    {
        //
    }

    /**
     * Remove the specified resource from storage.
     */
    public function destroy(string $id)
    {
        //
    }
}

Энэ кодонд өргөн хэрэглэгддэг функцүүдийг хамтад нь үүсгэж өгсөн байна.

Одоо бид Controller файлыг үүсгэсэн хэдий ч түүнийг дуудаж ажиллаж байгааг хянах боломжийг бүрдүүлэхийн тулд Routing ийг удирдах шаардлагатай болдог.

11. Routing

Хэрэглэгчээс авиваа хүсэлт нь шууд Route дээр ирдэг бөгөөд Route нь тэрхүү хүсэлтэд шууд хариулах уу аль эсвэл Controller -руу дамжуулах уу гэдгийг шийддэг гол удирдлага болдог хэсэг гэж ойлгож болно. Өөрөөх хэлбэл хүсэлтэд ШУУД ХАРИУЛАХ аль эсвэл ЯМАР CONTROLLER-ийн ЯМАР FUNCTION руу шилжүүлэх вэ? гэдгийг шийддэг гол удирдлага хэсэг гэж ойлгож болох юм.

Routing-ийг удирдахын тулд routes фолдер дотор байгаа файлуудыг удирдаж сурах ёстой болдог. Жишээ нь бид бүхэн API үүсгэн ашиглах гэж байгаа болохоор эхлээд routes/api.php файлд дуудалтын төрөл бүрийн хэлбэрүүдийг бичиж туршилт хийж болох юм.

  1. Шууд route

    Энэ нь хэрэглэгчээс ирсэн хүсэлтэд өөрөө шууд хариулах боломжтой хэлбэр юм.

    routes/api.php

    Route::get('/greeting', function () {
    return 'Hello World';
});

    Энэхүү route-ийг бичсэнээр http://localhost:8000/api/greeting гэсэн хүсэлт ирэхэд Hello World гэсэн хариуг буцаах буцаах юм.

    Мөн

    routes/api.php дотор

    Route::get('/hi', function () {
    return 'How are you?';
});

    Энэхүү route-ийг бичсэнээр http://localhost:8000/api/hi гэсэн хүсэлт ирэхэд How are you? гэсэн хариуг буцаах буцаах юм.

    Мөн Controller дээр хийгдэж байгаа бүх үйлдлүүдийг тухайн route дотор хийж болох хэдий ч тодорхой үүрэг бүхий Controller руу чиглүүлж өгвөл код бичиж байгаа хүндээ илүү ойлгомжтой болдог. Тиймээс route-үүд нь тухайн хаягийг заасан CONTROLLER-ийн заасан FUNCTION руу холбож өгдөг.

  2. Ирсэн хүсэлтийг Controller-ийн функц руу чиглүүлэх

    Ирсэн хүсэлтийг Controller-ийн заасан функц руу дамжуулах үйлдэл нь дараах байдлаар бичигдэнэ.

    routes/api.php дотор дараах чиглүүлэх кодыг бичиж болох юм.

    Route::get('/courses', [CourseController::class, 'index']);
Route::get('/courses/{id}', [CourseController::class, 'show']);
Route::post('/courses', [CourseController::class, 'store']);
Route::post('/courses/{id}', [CourseController::class, 'update']);
Route::delete('/courses/{id}', [CourseController::class, 'destroy']);

    Жишээ нь: routes/api.php дотор дараах чиглүүлэх кодыг бичиж өгөхөд.

    Route::get('/courses', [CourseController::class, 'index']);

    Дээрх чиглүүлэх код нь http://localhost:8000/api/courses гэсэн URL хаяг get method-оор дуудагдах үед CourseController нэртэй Controller-ийн index нэртэй функц дуудагдана гэсэн хэллэг юм. CourseController -ийн index функцийг авч үзвэл

    public function index()
{
    // 
}

    байх бөгөөд энэ функц нь параметргүй байна. Уг функц дотор return -ийн тусламжтайгаар хүссэн үр дүнгээ буцааж болно гэсэн үг юм.

    Route::get('/courses/{id}', [CourseController::class, 'show']);

    Дээрх чиглүүлэх код нь http://localhost:8000/api/courses/12 гэсэн URL хаяг get method-оор дуудагдах үед CourseController нэртэй Controller-ийн show нэртэй функц дуудагдана гэсэн хэллэг юм. CourseController -ийн show функцийг авч үзвэл

    public function show(string $id)
{
    // 
}

    байх бөгөөд энэ функц нь string $id гэсэн нэг параметртай байна. Уг функц дотор return -ийн тусламжтайгаар $id -ийг ашиглан тухайн өгөгдөл хайж хэрэгцээт үр дүнгээ буцааж болно гэсэн үг юм.

    Route::post('/courses', [CourseController::class, 'store']);

    Дээрх чиглүүлэх код нь http://localhost:8000/api/courses гэсэн URL хаяг post method-оор дуудагдах үед CourseController нэртэй Controller-ийн store нэртэй функц дуудагдана гэсэн хэллэг юм. CourseController -ийн store функцийг авч үзвэл

    public function store(Request $request)
{
    // 
}

    байх бөгөөд энэ функц нь Request $request гэсэн нэг параметртай байна. Уг функц дотор return -ийн тусламжтайгаар $request хувьсагчийн тусламжтайгаар ирсэн утгыг авч өгөгдлийн бааз руу хадгалах үйлдлийг хийж амжилттай болсон эсэх талаарх мэдээллийг буцааж болно.

    Route::post('/courses/{id}', [CourseController::class, 'update']);

    Дээрх чиглүүлэх код нь http://localhost:8000/api/courses/23 гэсэн URL хаяг post method-оор дуудагдах үед CourseController нэртэй Controller-ийн update нэртэй функц дуудагдана гэсэн хэллэг юм. CourseController -ийн update функцийг авч үзвэл

    public function update(Request $request, string $id)
{
    // 
}

    байх бөгөөд энэ функц нь Request $request, string $id гэсэн 2 параметртай байна. $id -ийн утга бүхий өгөгдлийн өгөгдлийн сангаас хайж олоод $request хувьсагчид ирсэн утгаар өөрчилж хадгална. Уг функц дотор return -ийн тусламжтайгаар өгөгдлийн баазыг утгыг амжилттай өөрчилж чадсан эсэх таларх мэдээллийг буцааж болно.

    Route::delete('/courses/{id}', [CourseController::class, 'destroy']);

    Дээрх чиглүүлэх код нь http://localhost:8000/api/courses/33 гэсэн URL хаяг delete method-оор дуудагдах үед CourseController нэртэй Controller-ийн destroy нэртэй функц дуудагдана гэсэн хэллэг юм. CourseController -ийн destroy функцийг авч үзвэл

    public function destroy(string $id)
{
    // 
}

    байх бөгөөд энэ функц нь string $id гэсэн нэг параметртай байна. Уг функц дотор return -ийн тусламжтайгаар $id -ийн id бүхий мөрийг хайж олоод устгах үйлдэл хийх ба устгах үйлдэл амжилттай болсон эсэх талаарх мэдээллийг буцааж болно.

    Мөн routing -ийн үйлдлүүд нь зөв болсон эсэхийг шалгахдаа дараах командыг ашигладаг.

    php artisan route:list

    Энэ команд нь одоо ажиллаж байгаа зөв route-үүдийг гаргаж харуулах үүрэгтэй байдаг.

    Мөн Routing-ийн эдгээр хэлбэрээс гадна өөр маш олон төрлийн Route-ийн хэлбэрүүд байдаг. Тэдгээрийг дараа дараагийн хэрэгцээт хэсгүүдэд нь тайлбарлаад явах болно.

Даалгавар

Та routes/api.php дотор үүсгэж болох бүх route-ийг зөв бичиж оруулах хэрэгтэй. Нийт 5 controller байгаа бөгөөд controller тус бүрд 5 функц байгаа учир нийт 25ш route бичигдэх ёстой.

12. CRUD үйлдэл

CRUD (Create, Read, Update, Delete) гэсэн үндсэн 4 үйлдлийг API-ийн тусламжтайгаар гүйцэтгэх боломжийг олгохдоо Controller дотрох функцүүдээ ашиглан хэрэгжүүлдэг. Уг функцүүд нь Model-ийг ашиглан өгөгдлийн баазаас өгөгдөл унших, үүсгэх, өөрчлөх, устгах үйлдлүүдийг гүйцэтгэдэг.

Энэ хэсэгт бид эхлээд энгийн үйлдлүүдийг авч үзэх бөгөөд дараа нь түүнийг сайжруулах форматлах зэрэг үйлдлүүдийг хэрхэн гүйцэтгэх талаар авч үзнэ.

Read - Хүснэгтийн бүх өгөгдлийг уншиж авах

Read буюу өгөгдлийн бааз дээрээс хүснэгтийн бүх өгөгдлийн уншиж авах үйлдэл өөрөөр хэлбэл SELECT * from table query-ийн үр дүнг дараах байдлаар зохион байгуулж болно.

Route::get('/courses', [CourseController::class, 'index']);

Дээрх чиглүүлэх код нь http://localhost:8000/api/courses гэсэн URL хаяг get method-оор дуудагдах үед CourseController нэртэй Controller-ийн index нэртэй функц дуудагдана гэсэн хэллэг юм. CourseController -ийн index функцийг авч үзвэл

use App\Models\Course;
...
public function index()
{
    return Course::all();
}

CourseController дотор use App\Models\Course; нь Course нэртэй model-ийг import хийн оруулж ирж байгаа бөгөөд CourseController дотор Course нэртэй model-ийн all() функцийн тусламжтайгаар өгөгдлийн баазын өгөгдлүүдийг бүгдийг нь авч байгаа үйлдэл юм.

Энэхүү кодын бид дараа дараагийн ойлголтууд дээр сайжруулаад явах юм.

Read - Хүснэгтийн өгөгдсөн нэг $id бүхий нэг мөрийн өгөгдлийг уншиж авах

Read буюу өгөгдлийн бааз дээрээс $id-тай тэнцүү байх хүснэгтийн нэг мөрийн өгөгдлийн уншиж авах үйлдэл өөрөөр хэлбэл SELECT * from table where id=$id query-ийн үр дүнтэй ижил гэсэн үг юм.

Route::get('/courses/{id}', [CourseController::class, 'show']);

Дээрх чиглүүлэх код нь http://localhost:8000/api/courses/11 гэсэн URL хаяг get method-оор дуудагдах үед CourseController нэртэй Controller-ийн show нэртэй функц дуудагдана гэсэн хэллэг юм. CourseController -ийн show функцэд бичигдэх кодыг авч үзье

use App\Models\Course;
...
public function show(string $id)
{
    return Course::find($id);
}

CourseController дотор Course нэртэй model-ийн find() функцийн тусламжтайгаар өгөгдлийн баазын id талбарын утга нь $id тэнцүү байх нэг мөр өгөгдлүүдийг шүүж авч байгаа үйлдэл юм. Тэгээд тухайн шүүж авсан мөрөө return-ийн тусламжтайгаар буцааж байна.

Create - Өгөгдөл хадгалах

Create буюу өгөгдлийн бааз руу хэрэглэгчээс ирсэн (postman-ээс ирсэн) json форматтай өгөгдлийн хадгалах үйлдэл insert into table(fields) values(values) query-ийн үр дүнтэй ижил гэсэн үг юм.

Route::post('/courses', [CourseController::class, 'store']);

Дээрх чиглүүлэх код нь http://localhost:8000/api/courses гэсэн URL хаяг post method-оор дуудагдах үед CourseController нэртэй Controller-ийн store нэртэй функц дуудагдана. CourseController -ийн store функцэд бичигдэх кодыг авч үзье

use App\Models\Course;
...
public function store(Request $request)
{
    $res=Course::create([
        'teacher_id'=> $request->teacher_id,
        'grade'=> $request->grade,
        'group'=> $request->group,
        'YearLesson'=> $request->YearLesson,
        'isActive'=> $request->isActive
    ]);
    return $res;
}

CourseController дотор Course нэртэй model-ийн create() функцийн тусламжтайгаар өгөгдлийг өгөгдлийн бааз руу хадгалах үйлдэл хийж байна. Тэгээд хадгалсан талаарх мэдээллийг $res хувьсагчид аваа тухайн хувьсагчийн утгыг return -ийн тусламжтайгаар буцааж байна.

Update - Өгөгдлийг өөрчлөх

Update буюу бааз дахь өгөгдлийг хэрэглэгчээс ирсэн (postman-ээс ирсэн) json форматтай өгөгдлөөр өөрчлөн хадгалах үйлдэл update fields=values where id=$id query-ийн үр дүнтэй ижил гэсэн үг юм.

Route::post('/courses/{id}', [CourseController::class, 'update']);

Дээрх чиглүүлэх код нь http://localhost:8000/api/courses/22 гэсэн URL хаяг post method-оор дуудагдах үед CourseController нэртэй Controller-ийн update нэртэй функц дуудагдана. CourseController -ийн update функцэд бичигдэх кодыг авч үзье

use App\Models\Course;
...
public function update(Request $request, string $id)
    {
        $oneCourse=Course::find($id);
        
        if($oneCourse){
            $res=$oneCourse->update([
                'teacher_id'=> $request->teacher_id,
                'grade'=> $request->grade,
                'group'=> $request->group.' UPDATED',
                'YearLesson'=> $request->YearLesson,
                'isActive'=> $request->isActive
            ]);
            return $id." кодтой өгөгдөл өөрчлөгдлөө";
        }else{
            return $id." кодтой өгөгдөл байхгүй";
        }        
    }

CourseController дотор Course нэртэй model-ийн update() функцийн тусламжтайгаар өгөгдлийг өгөгдлийн баазаас хайж олоод өгөгдсөн утгаар өөрчлөн хадгалах үйлдэл хийж байна. Тэгээд хадгалсан талаарх мэдээллийг $res хувьсагчид авач тухайн хувьсагчийн утгыг return -ийн тусламжтайгаар буцааж болно.

Delete - Өгөгдлийг устгах

Delete буюу хэрэглэгчээс ирсэн $id бүхий өгөгдлийг баазаас хайж олоод устгах үйлдэл delete table where id=$id query-ийн үр дүнтэй ижил гэсэн үг юм.

Route::delete('/courses/{id}', [CourseController::class, 'destroy']);

Дээрх чиглүүлэх код нь http://localhost:8000/api/courses/33 гэсэн URL хаяг delete method-оор дуудагдах үед CourseController нэртэй Controller-ийн destroy нэртэй функц дуудагдах ба CourseController -ийн destroy функцийг авч үзвэл

public function destroy(string $id)
    {
        $res=Course::find($id);       

        if ($res.count()>0){
            $res->delete();
            $data=[
            'status'=>'1',
            'msg'=>'success'
          ];
          }else{
            $data=[
            'status'=>'0',
            'msg'=>'fail'
          ];
        }
    }

Уг функц дотор return -ийн тусламжтайгаар $id тай тэнцүү байх мөрийг хайж олоод устгах үйлдэл хийх ба устгах үйлдэл амжилттай болсон эсэх талаарх мэдээллийг буцааж болно.

Даалгавар

Та бусад бүх Controller-ийн кодыг бичиж гүйцээх хэрэгтэй байна.

13. Resource-форматлах

Controller нь өгөгдлийн баазаас мэдээлэл авч шууд илгээж байсан. Үүнийн шууд илгээхгүйгээр тодорхой форматад хувиргаж илгээх үйлдлийг Resourse файлын тусламжтайгаар гүйцэтгэж болно.

Форматлах Resourse файлыг үүсгэхдээд дараах командыг ашиглана.

Жишээ нь CourseResource файлыг үүсгэх

php artisan make:resource CourseResource

Үүсгэсэн Resourse файлыг дараах форматаар өгч болох юм.

use App\Http\Resources\TeacherResource;
use App\Http\Resources\StudentResource;
....
public function toArray(Request $request): array
    {
        //return parent::toArray($request);
        return [
            "id"=> $this->id,
            "class"=>$this->grade.$this->group,
            "teacher"=> TeacherResource::make($this->teacher),
            "YearLesson"=>$this->YearLesson,
            "students"=>[
                 "count"  =>$this->students->count(),
                 "list"=>StudentResource::collection($this->students)
            ],
            "attendances"=>[
                "count"  =>$this->attendances->count(),
                'list'=>$this->attendances
            ]
        ];

    }

2 хэлбэрээр үүсгэж болох юм

php artisan make:resource CourseResource
php artisan make:resource CourseCollection
14.

php artisan make:controller PhotoController --model=Photo --resource --requests

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages