APIバグレポートテンプレート

APIバグレポートテンプレート

APIにはUIバグと比較して固有のデバッグ要件があります。API固有のテンプレートは、ネットワークレベルの問題を再現するために必要な技術的詳細を収集します。

APIバグに必須のフィールド

name: "API Bug Report"
description: "APIエンドポイントの問題を報告"
title: "[API]: "
labels: ["bug", "api"]
body:
  - type: input
    id: endpoint
    attributes:
      label: "エンドポイント"
      description: "影響を受けるエンドポイントの完全なURLまたはパス"
      placeholder: "GET /api/v2/users/:id"
    validations:
      required: true
  - type: dropdown
    id: http_method
    attributes:
      label: "HTTPメソッド"
      options:
        - "GET"
        - "POST"
        - "PUT"
        - "PATCH"
        - "DELETE"
    validations:
      required: true

なぜrender: jsonを使うか？

textareaフィールドのrender属性は、GitHubにコンテンツのシンタックスハイライトを指示します。render: jsonを使用すると、提出されたIssue内のリクエストとレスポンスボディがはるかに読みやすくなります。

セキュリティに関する考慮事項

認証トークン、APIキー、個人を特定できる情報を送信前に削除するよう報告者に注意するmarkdownセクションを追加してください。機密データを削除したことを確認するチェックボックスを含めます。