laravel apiダウンロード - laravel apiソースコードのダウンロード

laravel api

パイソン

1.0.0

ダウンロード

Laravel/PHPバックエンドプロジェクト

ライブ本番ビルドへのリンク

私の別の API プロジェクトへようこそ。このプロジェクトでは、次のようなフレームワークの強力な機能の多くを利用して、フルスタックプロジェクトの一部として Laravel アプリケーションを作成、テスト、デプロイしました。

ファサードとヘルパー機能。
ユーザーの認証と認可。
データベースのシード処理。
雄弁な 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 フラグメントを追加します。ルートエンドポイントにアクセスすると、さらに詳細を表示できます。

リソース	説明	認証・認可
投稿/サインアップ	新しいアカウントを作成します。	公共
POST /ログイン	既存のアカウントにログインします。	公共
GET /logout/{id}	ログアウトします (トークンを取り消します)。	ログインしているユーザーのみ
GET /exams	すべての試験のリストを表示します。 5 つのオプションのクエリパラメータが含まれます。	管理者専用
/exams/{id} を取得	特定の試験を受けてください。	自分の試験のみを見ることができます
PUT /exams/{id}	特定の試験を変更します。	自分の試験のみを編集できます
GET /exams/search/{名前}	特定の候補の部分文字列検索。	管理者専用
/exams/{id} を削除します	試験を削除します。	自分の試験のみを削除できます
GET /users	すべてのユーザーのリストを取得します。	管理者専用
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 。

リポジトリをフォークしてクローンします。
cd でリポジトリに移動し、次の CLI コマンドを実行します。
```
 composer update
 composer install
```

.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*