API_TEMPLATE.md

ドキュメント名

APIに関する説明を記述します。

APIを利用するためには

必要ライブラリやセットアップ内容等を記述します。

共通事項

リクエスト

エンドポイント

https://api.example.com/v1

レスポンス

• 形式: JSON
• Content-Type: application/json

リクエストが正常終了した場合

{
  response: $(object: API毎のレスポンス)
}

エラーが発生した場合

{
  response: {
    error_code:     $(string: エラーコード),
    error_message:  $(string: エラーメッセージ)
  }
}

エラーコード

コード	説明
E00001	パラメータが不足している
E00002	予期せぬエラーが発生

エンドポイント一覧

エンドポイントの名前

GET /v1/sample

エンドポイントに関する説明文を記述します。

パラメータ

パラメータ名	説明
hello	ほげほげ
world	ひげひげ

レスポンス

{
  sample: {
    hello: $(string: 値の説明),
    something: [
      {
        level: $(integer: 値の説明)
      }, ...
    ]
  }
}

エラーコード

コード	説明
E00001	パラメータが不足している

---