API Platform

ユーザが動的にリソースを作成および利用できる汎用的なAPI基盤。 任意のリソースを作成し、そのリソースに対してCRUDを実行できます。

※ 開発中

Demo

1. 試しに、ToDo管理のためのリソース「todo」を作成してみます。

   
   Table 1. todoリソースのデータスキーマの詳細

   プロパティ名	型	役割
   id	文字列	主キーになる
   task_name	文字列	タスクの名前

2. 作成したToDo管理リソースに対して、Postメソッドを実行してタスクを追加します。

   

3. Getメソッドを実行することで、追加したタスク一覧を確認できます。

   

4. 他にもDeleteなどのCRUDが実装されています。データスキーマを好きな形に変更することによって、様々なユースケースで活用できます。

Usage

Requirements

実行環境

• .NET 6

• Docker

ツール

• Visual Studio Code (開発環境)

• Postman などの Web API テストツール

• DBeaver などのSQLクライアントツール

Installation

1. docker ディレクトリ内で docker-compose up -d を実行する。

2. docker/.env ファイルのデータベース接続情報を書き換える。

3. DBeaver を用いてデータベースにアクセスする。アクセス情報の例は以下。(.envファイルを書き換えていない場合)

   • Host: localhost

   • Port: 5432

   • データベース名: db

   • ユーザ名: root

   • パスワード: pass

4. docker/ddl.sql ファイルのテーブル生成SQLを実行する。

5. VS Code で Gsuke.ApiPlatform ディレクトリを開く。

6. Ctrl + F5 キーを押下してプロジェクトを実行する。

7. Postman を用いて https://localhost:7033/resource にアクセスし、 [] が返却されることを確認する。

   
   

Tutorials

※ 執筆中

Documents

※ 執筆中

License

MIT LICENSE

今後の予定

• 自動テストを実装

• デプロイ