Skip to content
This repository has been archived by the owner on Jul 19, 2019. It is now read-only.

Latest commit

 

History

History
48 lines (27 loc) · 1.73 KB

API.md

File metadata and controls

48 lines (27 loc) · 1.73 KB

API简述

本文档意在简述API,故不将对API具体字段、请求方式等作出规定,请开发人员不要依据此份简述编写业务代码,请参照具体的API规范(未编写)。

另外,此份API简述将会经常修改,且不保证这些修改的兼容性。

标识符说明

文档中会出现一些对字段的标识符:

⚠️:谨慎修改。表示对应的字段若非必要,否则不要修改。

🔽:要求顺序。用于Object或Array类型的字段,表示对应的字段要求严格按照本简述规定的顺序呈递。

注意事项

本部分规定了一些开发时注意事项。主要规定的一些说法,以及正则表达式等。

用户信息;登录及注册

  • 登录方式为:“用户名或注册邮箱”
  • 用户密码:^[\x00-\xff]{6,16}$。匹配单字节字符,6-16位。

通用字段解释

本部分主要用于解释一些硬编码的字段。本部分规定的解释法将全局通用

⚠️ 性别 - Integer: gender

用于标识用户的性别。

可能的取值 0 1 2 3
解释 保密 男性 女性 其它
  • *注释:*开发时,请标明“心理性别”。

用户链接 - Object: links

用于链接到用户的其它主页或相关联系方式。

GitHub ZhiHu StackOverflow V2EX Twitter
对应的值类型 String String String String String
必须?
  • *注释:*上述对应的值应为完整URL。