Шаблон документа интерфейса API в стиле RESTful

1 Имя интерфейса

Интерфейс регистрации пользователей

2 Описание интерфейса

1. Регистрация информации о пользователе
2. Пользователи могут зарегистрироваться по номеру мобильного телефона/электронной почте
3. Только одна учетная запись может быть зарегистрирована с одним и тем же номером мобильного телефона/электронной почтой.

3 адрес запроса

{apiAddress}/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