前后端开发接口文档模板（登录、注册、项目发布与需求发布）

原创已于 2022-07-09 18:19:51 修改 · 3.9k 阅读

10 ·

CC 4.0 BY-SA版权

文章标签：

#json #flask #python

于 2022-07-04 14:34:03 首次发布

本文介绍了一个包含用户注册、登录及项目发布的API接口设计案例。详细解释了各接口的请求与响应示例，包括必要的参数说明及其数据类型。

接口列表

接口名称	接口描述	开发情况
UserRegister	用户注册	[ TODO ]
UserLogin	用户登录	[ TODO ]
PublishProjects	发布项目	[ TODO ]
ReleaseRequirements	发布需求	[ TODO ]

用户注册 (UserRegister)

**请求样例： **

    "data": {
        "user_name": "xxx",
        "password": "xxx",
        "password_confirm": "xxx",
      	"phone": "111111111"
      	
    }

**参数说明: **

字段名称	类型	必须	描述
user_name	string	是	用户名
password	string	是	用户密码，需要加密处理
password_confirm	string	是	用户密码确认，需要加密处理
phone	string	是	用户手机号码

**返回样例： **

{
    "msg": "success",
    "code": 200
}

**参数说明: **

字段名称	类型	描述
msg	string	返回注册结果
code	string	返回操作结果代码

用户登录 (UserLogin)

**请求样例： **

    "data": {
      	"user_name": "xxx",
        "password": "xxx"
    }

**参数说明: **

字段名称	类型	必须	描述
user_name	string	是	用户名
password	string	是	用户密码，需要加密处理

**返回样例： **

{
    "msg": "success",
    "code": 200
}

**参数说明: **

字段名称	类型	描述
msg	string	返回登录结果
code	string	返回操作结果代码

发布项目(PublishProjects)

**请求样例： **

{
    "title": "XXXXXX",
    "context": "XXXXXXXXXXXXXXXXXXXXXXX",
    "project_type": "XXXXX",
    "money": "10000",
    "user_name": "XXX",
    "user_industry": "XXXXXX",
    "phone": "1111111111",
    "contact": "XXXXX",
    "address": "XXXXXX",
    "user_id": 1
}

**参数说明: **

字段名称	类型	必须	描述
title	string	是	项目名
context	string	是	项目详细内容
project_type	string	是	项目类别
money	string	是	项目意向金额
user_name	string	是	项目发布人用户名
user_industry	string	是	项目发布人所属行业
phone	string	是	项目发布人联系电话
contact	string	是	项目发布人联系途径
address	string	是	项目发布人所属地
user_id	int	是	项目发布人用户id

**返回样例： **

{
    "msg": "success",
    "code": 200
}

**参数说明: **

字段名称	类型	描述
msg	string	返回项目发布结果
code	string	返回操作结果代码

发布需求(Release requirements)

**请求样例： **

{
    "title": "XXXXXX",
    "context": "XXXXXXXXXXXXXXXXXXXXXXX",
    "project_type": "XXXXX",
    "money": "10000",
    "employer_name": "XXX",
    "employer_industry": "XXXXXX",
    "phone": "1111111111",
    "contact": "XXXXX",
    "address": "XXXXXX",
    "ddl": "XXXXXX",
    "user_id": 1
}

**参数说明: **

字段名称	类型	必须	描述
title	string	是	需求名
context	string	是	需求详细内容
project_type	string	是	需求项目类别
money	string	是	意向金额
user_name	string	是	需求发布人用户名
user_industry	string	是	需求发布人所属行业
phone	string	是	需求发布人联系电话
contact	string	是	需求发布人联系途径
address	string	是	需求发布人所属地
ddl	string	是	需求完成期限
user_id	int	是	需求发布人用户id

**返回样例： **

{
    "msg": "success",
    "code": 200
}

**参数说明: **

字段名称	类型	描述
msg	string	返回项目发布结果
code	string	返回操作结果代码