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

接口列表

接口名称	接口描述	开发情况
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	返回操作结果代码

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

一份很不错的敏捷产品接口文档模板
在采用敏捷研发的过程中,前后端开发人员如何来描述与记录接口信息?如何精简的描述接口的用处?接口的请求方式?接口的入参是什么?返回模型是什么等等. 结合我们项目团队多年的实际情况以及授课老师的推荐,我觉 ...
postman项目接口文档和登录步骤原理
培训内容实训项目:非常果岭-发现模块接口测试,单接口.流程脚本编写: 使用工具:postman 培训方式 1)postman使用说明 2)项目接口文档和登录步骤原理一.首先了解postman使用 ...
开发接口文档_产品经理必懂的接口文档撰写方式
做产品经理的难免会调研各式各样的第三方需求能力.以满足产品提供用户的市场价值,比如第三方登录.图像识别.风控算法,都有专注的服务厂商. 企业无需自己花时间和精力投入在具有较高技术壁垒或时间成本的需求上 ...
开发接口文档_更优更稳更好，看文档驱动开发模式在AIMS中的优势
[摘要]程序员常会说:我最讨厌别人写的代码没有文档,我也最讨厌自己需要写文档. 有一个很老的梗: 我最讨厌别人写的代码没有文档,我也最讨厌自己需要写文档. 有这种想法的程序员应该算是一个老鸟了,对于 ...
使用swagger编写开发接口文档
1.在pom.xml中导入依赖 <dependency><groupId>io.springfox</groupId><artifactId>sprin ...
软件开发接口文档
接口文档没有固定的样式,只要把相关的信息显示出来就可以例如: 接口名称接口说明接口地址请求参数返回参数错误码(一般大批量的接口都使用统一的错误码来返回) 下面是本人使用过的接口文档样式这 ...
Macdown接口文档模板
样式: macdown 代码: #xxx接口文档版本:版本 | 日期 |操作人 --- |---|--- v1 | 2019-10-11|xx ##1.根据筛选条件获取工单列表 ###1.1接口ur ...
需求分析文档模板_我们应该如何进行需求管理「下篇」？
前两篇文章分别介绍了需求管理的基本定义.分类方式.重要意义和一些常见的项目失败原因.通过前文的介绍,想必大家对于需求管理的基础概念都已经有了新的认识. 那么,让我们进入到最核心的部分,同时也是需求管理 ...
作为参数给后端为空_后端 API 接口文档 Swagger 使用指南
前言作为一个以前后端分离为模式开发小组,我们每隔一段时间都进行这样一个场景:前端人员和后端开发在一起热烈的讨论"哎,你这参数又变了啊","接口怎么又请求不通了啊&quo ...
https接口_API设计指南一个接口文档模板的最佳实践
1. 基础说明 1.1 背景 API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件的以访问一 ...

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

接口列表

用户注册 (UserRegister)

用户登录 (UserLogin)

发布项目(PublishProjects)

发布需求(Release requirements)

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

最新文章

热门文章