RESTful スタイルの API インターフェイス ドキュメント テンプレート

1 インターフェース名

ユーザー登録インターフェース

2 インターフェースの説明

1. ユーザー情報の登録
2. ユーザーは携帯電話番号/メールアドレスで登録できます
3. 同じ携帯電話番号/メールアドレスで登録できるアカウントは1つだけです

3 リクエストアドレス

{apiアドレス}/api/user/signup

4 リクエスト方法

役職

5 リクエストパラメータ

5.1 ヘッダーパラメータ

パラメータ名	必要	タイプ/パラメータ値	説明する
コンテンツタイプ	はい	アプリケーション/json	リクエストパラメータのタイプ

5.2 本体パラメータ

パラメータ名	必要	タイプ	制限要因	説明する	値の例
アカウント	はい	弦	1 < 長さ < 50	ユーザーアカウント
パスコード	はい	弦	1 < 長さ < 50	パスワード
チェックコード	はい	弦	長さ = 6	検証コード

注：パスワード（パスコード）の暗号化方式はxxxxxxです。

呼び出す必要があるその他のインターフェイス:

インターフェース名	インターフェースアドレス	使用説明書
確認コードを取得する	{apiAddress}/api/common/getCheckCode	登録に必要な認証コードを取得する

5.3 リクエスト例

{
    
    
"account" : 1001,
"passcode" : 123456,
"checkCode" : 1
}

​

6 応答パラメータ

6.1 戻りパラメータ

パラメータ名	必要	タイプ	制限要因	説明する	値の例
アカウント	はい	弦	1 < 長さ < 50	ユーザーアカウント
パスコード	はい	弦	1 < 長さ < 50	パスワード
チェックコード	はい	弦	長さ = 6	検証コード

6.2 戻り例

{
    
    
    "code": 200,  // 状态码
    "msg": "成功",  // 提示信息
    "data": null  // 返回内容
}

7 備考

戻りエラー コードの詳細については、ホームページの戻りステータス コード表を参照してください。

8 エラー応答コード (オプション)

エラーコード	間違った説明	理由	解決	値の例
システムエラー	インターフェースがエラーを返す	システムタイムアウト	同じパラメータを使用して API を再度呼び出してください。	001