DotArt API

DotArt の API です。 実行する際はdocker-compose upをし立ち上げてから行ってください。

環境

言語: TypeScript

FW

• Nest.js 構成は こちら のドキュメントを参考にしてください。
• prisma
• fastify
• swagger

DB

• postgresql ※ docker に乗せている

コマンド

実行

$ yarn start

dev 実行

$ yarn start:dev

デバック実行

$ yarn start:debug

プロダクション実行

$ yarn start:prod

ビルド

$ yarn build

プリビルド

$ yarn prebuild

prisma studio

$ yarn prisma studio

マイグレーション

マイグレーションは以下の通り行ってください。

# テーブル
$ yarn prisma migrate dev --preview-feature && yarn prisma db seed

@prisma/client からマイグレーションしたものを扱えるように

$ yarn prisma generate

CRUD ジェネレーター

$ nest g resource

? What name would you like to use for this resource (plural, e.g., "users")? モデル名
? What transport layer do you use? REST API
? Would you like to generate CRUD entry points? Y

API Document

実行中に以下へアクセスすることで OpenAPI でドキュメントを確認できます。 http://localhost:5000/docs

エンドポイントは以下になります。 http://localhost:5000/api/v1

参考

Nest.js と prisma の連携

Nest.js prisma チュートリアル

nest.js + prisma + fastify + postgresql で REST API の CRUD を作成する

open api のドキュメント生成

prisma の定義ファイルの書き方

NestJS 公式ドキュメント日訳