APIドキュメント

DeokjilHub公開REST APIの使い方をご案内します。

https://api.deokjilhub.com

認証が必要なエンドポイントはAuthorizationヘッダーにBearerトークンを含める必要があります。

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

トークンはログイン時に発行され、access_tokenのデフォルト有効期限は30分です。期限切れ時は/api/v1/auth/refreshで更新します。

{
  "detail": "error message"
}

GETリソース取得

POSTリソース作成

PUTリソース更新

DELETEリソース削除

コード	名前	説明
200	OK	リクエスト成功
201	Created	リソース作成成功
204	No Content	削除成功（レスポンス本文なし）
400	Bad Request	不正なリクエストデータ
401	Unauthorized	認証が必要
403	Forbidden	権限なし
404	Not Found	リソースが見つかりません
409	Conflict	リソース競合（例：ニックネーム重複）
429	Too Many Requests	リクエスト回数超過（Retry-Afterヘッダー付き）

認証

認証済みユーザー情報を確認するエンドポイントです。ログインはWebブラウザで行い、発行されたトークンでAPIを呼び出します。

ボード一覧・詳細情報のエンドポイントです。ボード作成は管理者専用で、ユーザーはWeb UIからボード登録を申請できます。

コンテンツ一覧・詳細照会などのエンドポイントです。

コミュニティ投稿の作成、編集、削除およびボードフォロー関連のエンドポイントです。

プロフィール照会/編集、統計、コメント、フォロー中のボードなどのエンドポイントです。すべて認証が必要で、本人のデータのみ照会できます。

コンテンツリアクション（いいねなど）関連のエンドポイントです。

ポイント照会エンドポイントです。投稿（5P）、コメント（1P）などでポイントを獲得し、パーソナリティランダム化（10P）などに使用されます。

コメント/投稿に適用される口調設定です。5つの性向（ツンデレ、不思議、ウィット、温かい、情熱）と方言を組み合わせ、ランダム化で変更できます。

カテゴリ一覧照会エンドポイントです。