Spring Boot 業務API

SPEC

技術仕様

サーバー

• Java 17
• Spring Boot
• MyBatis

データ

• PostgreSQL

FIT

こんなプロジェクトに向いています

• 画面と外部システムが同じ業務データを共有する必要がある場合
• 既存APIが権限・例外処理の基準なしに増えてしまった場合
• 連携仕様を文書として引き渡す必要がある場合

PREBUILT

サンプルの構成

以下はサンプルで扱う構成です。テンプレートの機能と提供範囲は制作・検証後に確定します。

認証・権限の層

ログイン、トークン検証、ロール別のアクセス制御が動作する状態で用意されています。

標準の応答・例外形式

成功・失敗の応答形式とエラーコード体系が決まっており、画面側の処理基準がぶれません。

一覧・詳細・登録の基本構造

照会、詳細、登録・修正・削除とページング・並び替えが同じ規則で動作します。

API文書の自動生成

コードから連携仕様の文書を生成する設定が入っており、文書を別に管理しません。

プロジェクトに合わせて構成とデザインを調整します。

SCOPE

提供範囲

提供範囲と除外範囲を先に定義してから進めます。日程と詳細条件は打ち合わせのうえSOWで確定します。

FAQ

よくある質問

既存のデータベース構造をそのまま使う必要がありますか。

既存構造を優先して使用します。変更が必要な場合は影響範囲を先に確認し、SOWに反映します。

Javaやフレームワークのバージョンを指定できますか。

本番環境に合わせて指定できます。指定したバージョンはSOWの技術環境の項目に記録します。