laravel api

Laravel/PHP 백엔드 프로젝트

라이브 프로덕션 빌드 링크

내 API 프로젝트 중 하나에 오신 것을 환영합니다. 이 프로젝트에서는 다음과 같은 프레임워크의 강력한 기능을 활용하면서 전체 스택 프로젝트의 일부로 Laravel 애플리케이션을 작성, 테스트 및 배포했습니다.

• 파사드 및 도우미 기능;
• 사용자 인증 및 승인;
• 데이터베이스 시딩;
• Eloquent ORM 쿼리 빌더;
• 고급 API 테스트 도구.

그것은 무엇을 위한 것입니까?

이 API는 사용자/지원자 및 시험과 관련된 데이터를 처리합니다. 예를 들어, 사용자는 시험 장소/장소, 날짜, 응시자 이름 등에 대한 정보를 볼 수 있습니다.

액세스에 관한 중요 참고 사항

• API에 대한 모든 요청에 ​​Accept: application/json HTTP 헤더를 포함해야 합니다.
• 대부분의 API 기능은 관리자 수준의 사용자만 사용할 수 있습니다. 이 앱을 시험해 보려면 @v3.admin 으로 끝나는 이메일을 사용하여 새 계정에 가입하면 전체 관리자 권한을 얻을 수 있습니다.

 // To sign up as an admin, make a POST request to https://laravel-php-api.vercel.app/public/api/signup and include a request body in the following format:

        {
		    "name" : " Anna Torpid " ,
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf " ,
		    "password_confirmation" : " dfbdf9suhfd9shf "
        }

// To login, make a POST request to https://laravel-php-api.vercel.app/public/api/login and include a request body in the following format:

        {
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf "
        }

// The above POST request returns this response. Make sure to include the returned token in the authorisation header of all future requests.

        {
	        "user" : {
		        "id" : 11 ,
		        "name" : " Anna Torpid " ,
		        "email" : " [email protected] "
	        },
	        "token" : " 5|tAujbY9luWTKquNEruGHU7soCXp7MuzVb8WR0VO9 "
        }

가입하거나 로그인하면 전체 CRUD 액세스를 보장하기 위해 요청 헤더에 첨부해야 하는 API 토큰이 발급됩니다.

사용 가능한 엔드포인트

각 엔드포인트에 액세스하려면 루트 엔드포인트에 URI 조각을 추가하세요. 루트 엔드포인트를 방문하면 자세한 내용을 볼 수 있습니다.

의지	설명	인증/권한 부여
게시/가입	새 계정을 만드세요.	공공의
게시/로그인	기존 계정으로 로그인하세요.	공공의
GET /로그아웃/{id}	로그아웃합니다(토큰 취소).	로그인한 사용자만
GET /시험	모든 시험 목록을 표시합니다. 5개의 선택적 쿼리 매개변수가 포함되어 있습니다 .	관리자 전용
/시험/{id} 받기	구체적인 시험을 받아보세요.	자신의 시험만 볼 수 있음
PUT /시험/{id}	특정 시험을 수정합니다.	자신의 시험만 편집할 수 있습니다.
GET /시험/검색/{이름}	특정 후보에 대한 하위 문자열 검색입니다.	관리자 전용
/시험/{id} 삭제	시험을 삭제하세요.	자신의 시험만 삭제할 수 있습니다.
GET /사용자	모든 사용자 목록을 가져옵니다.	관리자 전용
GET /users/{id}/exams	사용자의 모든 시험 목록 가져오기	자신의 시험만 볼 수 있음

주요 제품 특징

• Vercel에 '서버리스 기능'으로 배포되어 PHP 런타임을 활용하여 애플리케이션 구성을 처리합니다.
• 프로덕션 배포는 다른 공급자를 통해 원격으로 호스팅되는 라이브 PSQL 데이터베이스에 연결됩니다.
• 광범위한 메소드 체이닝을 갖춘 표현형 Laravel 특정 구문으로 보다 간결한 코드 구조를 허용합니다.
• PHPUnit 및 Laravel의 유연한 JSON 구문(클로저 및 AssertableJson 클래스 기반)을 사용하여 테스트 기반 방식으로 개발되었습니다.
• Github Actions를 사용하여 구성된 CI/CD 워크플로를 사용한 자동화된 테스트입니다.
• 객체 지향 MVC 패턴을 사용하여 설계됨
• Sanctum을 활용한 인증 서비스 구현
  • 사용자는 회원가입 및 로그인이 가능합니다.
  • 보호된 경로는 유효한 API 토큰이 있는 사용자만 액세스할 수 있습니다.
• 인증에 대한 폐쇄 기반 접근 방식인 Laravel의 게이트를 사용하여 구현된 인증 서비스입니다.
  • 특정 작업은 관리자 상태와 같은 특정 역할을 가진 사용자에게만 허용됩니다.
• Eloquent ORM의 관계 도구를 사용하여 정의된 관계 및 스키마 제약 조건
• 개발 및 테스트에 사용되는 SQLite 데이터베이스입니다.

프로젝트 디렉터리의 기본 파일 및 폴더

• ./app에는 애플리케이션의 핵심 로직이 포함되어 있습니다.
  • /app/Http/Controllers에는 요청 처리 논리가 포함되어 있습니다.
  • app/Models에는 모든 모델 클래스가 포함되어 있으며 채울 수 있는 모든 필드를 지정하는 곳입니다.
  • app/Providers에는 전체 애플리케이션을 부트스트랩하는 클래스가 포함되어 있습니다.
• ./routes/api.php는 모든 경로(엔드포인트)를 간결하게 정의하는 곳입니다.
• ./tests/Feature에는 앱에 대한 모든 통합 테스트가 포함되어 있습니다.
• ./config/database.php를 사용하면 데이터베이스 연결 설정을 구성할 수 있습니다.
• ./database는 또 다른 매우 중요한 폴더입니다.
  • ./database/factories에는 데이터베이스를 시드하는 데 사용되는 팩토리 클래스가 포함되어 있습니다.
  • ./database/migrations를 사용하면 데이터 모델을 수정할 수 있습니다.
  • ./databse/seeders에는 팩토리를 통해 데이터베이스를 시드하는 클래스가 포함되어 있습니다.

로컬 환경에서 프로젝트 실행

먼저, 컴퓨터에 PHP와 Composer가 설치되어 있는지 확인하세요.

최소 버전 요구 사항: PHP ^8.1 ; 작곡가 2.5.4 .

1. 저장소를 포크하고 복제합니다.

2. 저장소로 cd하고 다음 CLI 명령을 실행합니다.

    composer update
    composer install
   

3. .env.example 파일의 이름을 .env 로 바꾸고, 기본 mysql 연결에 대한 변수를 제거하고, 다음 3개 변수를 추가했는지 확인하세요.

    DB_CONNECTION=sqlite
    DB_FOREIGN_KEYS=true
    USE_SQLITE_SYNTAX=like
    DB_DATABASE= this needs to be the absolute path to the sqlite database located in ./database/database.sqlite, e.g. /home/username/mydocuments/laravel-api/database/database.sqlite*
   

4. 로컬 개발 서버를 가동하려면 Artisan CLI 명령을 실행하세요:

    php artisan serve
   

5. 테스트 슈트를 실행하려면 Artisan CLI 명령을 실행하세요:

    php artisan test