/add

  • POST
  • application/json

PRODUCTION

https://example.com/add

STAGING

https://stg.example.com/add

追加を行います。

リクエスト

リクエストパラメータを記載します。

パラメータ名必須型説明
nameString氏名
telString電話番号
mailStringメールアドレス

レスポンス

レスポンスパラメータを記載します。

RESPONCE

[
  {
    "status": Boolean,
    "message": String
  }
]
パラメータ名型説明
statusBooleanパラメーターの備考
messageSrrayパラメーターの備考
idIntegerID
addresesStringアドレス
domainStringドメイン

/employee

  • GET
  • application/json

PRODUCTION

https://example.com/employee

STAGING

https://stg.example.com/employee

employeeデータを取得します。

レスポンス

成功

[
  {
    "id": String,
    "employee_name": String,
    "employee_age": String
  },
  {
    "id": "2",
    "employee_name": String,
    "employee_age": String
  }
  ...
]

失敗

[
  {
    "message": String
  }
]
パラメータ名型説明
idStringパラメーターの備考
employee_nameStringパラメーターの備考
employee_ageStringパラメーターの備考

/employee/{id}

  • GET
  • application/json

PRODUCTION

https://example.com/employee/{id}

STAGING

https://stg.example.com/employee/{id}

employeeデータを取得します。

リクエスト

パラメータ名必須型説明
idStringパラメーターの備考

レスポンス

成功

[
  {
    "id": String,
    "employee_name": String,
    "employee_age": String
  }
]

失敗

[
  {
    "message": String
  }
]
パラメータ名型説明
idStringパラメーターの備考
employee_nameStringパラメーターの備考
employee_ageStringパラメーターの備考

/codespan/{custom}

  • GET
  • application/json

PRODUCTION

https://example.com/codespan/{custom}

STAGING

https://stg.example.com/codespan/{custom}

ソースコードのカスタム記法です。

リクエスト

パラメータ名説明
id stringパラメーターの備考

レスポンス

成功

[
  {
    "id": String,
    "employee_name": String,
    "employee_age": String
  }
]
パラメータ名説明
id stringパラメーターの備考
employee_name stringパラメーターの備考
employee_age stringパラメーターの備考

Copyright © Example Inc.