api-designer

APIデザイナー

REST、tRPC、GraphQLの規約やエンドポイント構成、入出力形式、バージョニング、エラー処理を設計・レビューするスキル。

AIスキル大辞典による日本語要約
品質評価91/100評価確度:暫定
人気度(GitHub Star) 0発掘スコア 100
01

このSkillでできること

  • プロジェクトのAPIスタイルとベースパスを整理する
  • REST、tRPC、GraphQLのエンドポイント構成を設計する
  • リクエスト・レスポンス形式や認証方式を確認する
  • API変更やエラー処理の設計をレビューする
02

使い方

01
STEP 1

API、エンドポイント、REST、tRPC、GraphQLなどの相談時に使う

02
STEP 2

採用するプロトコルとベースパスをプロジェクトの規約に合わせて確認する

03
STEP 3

入力スキーマ、操作名、バージョニング、認証方式を整理する

04
STEP 4

既存APIの変更点とエラー処理をレビューする

03

Skillのインストール

このGitHubリポジトリにあるSkillを確認し、現在の環境に適した方法でインストールしてください。
インストール後、正常に利用できることを確認し、基本的な使い方も簡潔に説明してください。

Repository:
https://github.com/Jhunriz/dev-companion-skills
手動でインストールする

README / SKILL.mdから機械抽出できたコマンドのみ表示しています。推測したコマンドではありません。

git clone https://github.com/YOUR_USERNAME/dev-companion-skills.git .agents/skills/dev-companion-skills
git clone https://github.com/YOUR_USERNAME/dev-companion-skills.git .agents/skills
git clone https://github.com/YOUR_USERNAME/dev-companion-skills.git .opencode/skills/dev-companion-skills
ln -s .opencode/skills/dev-companion-skills/* .opencode/skills/
cp -r .agents/skills/skill-template .agents/skills/my-new-skill
mkdir -p .agents/skills/my-new-skill
04

このSkillを使うプロンプト例

Skill名を明示すると、意図したSkillを使わせやすくなります。自動発動型では必須とは限りません。

このプロジェクトのAPI規約に沿って、ユーザー一覧エンドポイントの構成、入力形式、レスポンス形式、エラー処理を設計してください。
出力例を見る
プロトコル、ベースパス、バージョニング、認証方式、Content-Type、エンドポイント構成、入力・出力形式、エラー処理を整理したAPI設計案。
05

安全性チェック

自動解析による参考情報です。Skillの安全性を保証するものではありません。

外部API通信明確な記述なし
Shellコマンド実行明確な記述なし
ファイル読み取り明確な記述なし
ファイル書き込み検出あり
ネットワークアクセス明確な記述なし
認証情報検出あり
検出根拠を見る
  • file_write: ed-skills"] } } } [large code block omitted]bash cp -r .agents/skills/skill-template .agents/skills/my-new-skill # Edit .agents/skills/my-new-
  • credential: / None | | **Auth** | Bearer token / Session cookie / API key | | **Content-Type** | `application/json` | ## REST Conventions (if applicable) ### End
06

関連Skill