后端 接口

最新推荐文章于 2024-04-18 20:42:23 发布
最新推荐文章于 2024-04-18 20:42:23 发布
阅读量1.4k 收藏 2
点赞数
分类专栏： 微信小程序开发--后端 文章标签： node.js
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Carrot_Jia/article/details/116589868
版权

文章目录

1. 微信登录

1.1 用户登陆

接口说明

微信登录，获取用户信息。
前端收集到用户登陆产生的临时code，后台通过此码可以向微信 jscode2session 接口请求到用户的唯一标志openid。获得openid后，若该用户是新用户，则将其信息存储进用户表。并向前端返回openid。
后续前端发起的端口请求，均需要通过openid来区分当前用户。

GET / login HTTP1.1
Content-Type: application/x-www-form-urlencoded

请求参数

字段属性说明
codestring微信登陆时产生的临时标识码。

返回结果

返回数据：

[
  {
    "openid": integer,	// 用户标识
  },...
]

返回信息：

成功时：
HTTP/1.1 200 OK

失败时(例子)：
HTTP/1.1 403 Forbidden
Content-Type: application/x-www-form-urlencoded
{"message" : "登录失败"}


2. 衣橱模块

2.1 衣物信息显示

接口说明

获取数据库中当前用户的所有衣物信息。

GET / closet HTTP1.1
Content-Type: application/x-www-form-urlencoded

请求参数

字段属性说明
openidinteger当前微信用户标识

返回结果

返回数据：

[
  {
    "cloid": integer,	// 衣物id
    "tgR": integer,		// 目标RGB值
    "tgG": integer,
    "tgB": integer,
    "code": integer,	//色彩码，1-26
    "inR": integer,		//原始RGB值
    "inG": integer,
    "inB": integer,
    "type": integer,			//衣物属性：种类 1短袖 2长袖 3毛衣 4棉服 5夹克 6西装外套 7连衣裙 8半身裙 9裤子
    "clothlength": integer,		//衣物属性：长度 1短 2中 3长
    "tightness": integer,		//衣物属性：松紧 1紧 2宽
    "thi": integer,				//衣物属性：薄厚 1薄 2中 3厚
    "picurl": string(url)		//图片地址
  },...
]

返回信息：

成功时：
HTTP/1.1 200 OK

失败时(例子)：
HTTP/1.1 403 Forbidden
Content-Type: application/x-www-form-urlencoded
{"message" : "获取衣物信息失败"}

2.2 衣物预览

接口说明

用户添加衣物，在选择衣物属性时，下方预览对应衣物图片。

GET / preview HTTP1.1
Content-Type: application/x-www-form-urlencoded

请求参数

字段属性说明
openidinteger用户标识
typeinteger衣物属性：种类
clothlengthinteger属性：长度
tightnessinteger属性：松紧
thiinteger属性：薄厚

返回结果

返回数据：

{
    "picurl": string(url),		//图片地址
    "inR": integer,				//原始RGB值
    "inG": integer,
    "inB": integer
}

返回信息：

成功时：
HTTP/1.1 200 OK

失败时(例子)：
HTTP/1.1 403 Forbidden
Content-Type: application/x-www-form-urlencoded
{"message" : "预览失败"}

2.3 衣物添加

接口说明

用户修改/添加衣物信息。若为修改已存在衣物，则仅更新该衣物的信息。若添加新衣物，则向该用户衣橱中增加该件衣物。

POST / add HTTP1.1
Content-Type: x-www-form-urlencoded

请求参数

字段属性说明
openidinteger用户标识
tgRinteger目标R值
tgGinteger目标G值
tgBinteger目标B值
colortypeinteger颜色种类(1:non 2:warm 3:cold)
codeinteger色彩码(1-26)
typeinteger衣物属性：种类
clothlengthinteger属性：长度
tightnessinteger属性：松紧
thiinteger属性：薄厚

返回结果

后端操作结束返回信息（无数据返回）。

成功时：
HTTP/1.1 200 OK

失败时(例子)：
HTTP/1.1 403 Forbidden
Content-Type: x-www-form-urlencoded
{"message" : "添加失败"}

2.4 衣物删除

接口说明

用户删除已有的一件衣物。

POST / delete HTTP1.1
Content-Type: application/x-www-form-urlencoded

请求参数

字段属性说明
openidinteger用户标识
cloidinteger衣物id

返回结果

后端操作结束返回信息（无数据返回）：

成功时：
HTTP/1.1 200 OK

失败时(例子)：
HTTP/1.1 403 Forbidden
Content-Type: application/x-www-form-urlencoded//
{"message" : "删除失败"}

3.穿搭模块

3.1 显示推荐穿搭

接口说明

根据用户拥有的衣物，推荐搭配方案。

GET / fashion HTTP1.1
Content-Type: application/x-www-form-urlencoded

请求参数

字段属性说明
openidinteger用户标识
weatherinteger当日温度

返回结果

返回数据：

[
  {
    "wholeType": integer,	//1:上下衣 2:裙子 3:外套+上下衣 4:裙子+外套
    "label": string,		//风格标签
    "tips": string,			//穿搭建议
    "upperCloth": { "inR": integer,					//原始RGB值
    				"inG": integer,
   				 	"inB": integer,
   				 	"tgR": integer,					//目标RGB值
    				"tgG": integer,
    				"tgB": integer,
    				"picurl": string(url)			//图片地址
    			  },
    "downCloth": {  "inR": integer,					
    				"inG": integer,
   				 	"inB": integer,
   				 	"tgR": integer,					
    				"tgG": integer,
    				"tgB": integer,
    				"picurl": string(url)			
    			 }, 
    "outerCloth": { "inR": integer,					
    				"inG": integer,
   				 	"inB": integer,
   				 	"tgR": integer,					
    				"tgG": integer,
    				"tgB": integer,
    				"picurl": string(url)			
    			  },
    "dress": {		"inR": integer,					
    				"inG": integer,
   				 	"inB": integer,
   				 	"tgR": integer,					
    				"tgG": integer,
    				"tgB": integer,
    				"picurl": string(url)			
    		 }, 
  },...
]

返回信息：

成功时：
HTTP/1.1 200 OK

失败时(例子)：
HTTP/1.1 403 Forbidden
Content-Type: application/x-www-form-urlencoded
{"message" : "获取穿搭失败"}

3.2 获取用户评价

接口说明

获取并储存前端传回的用户对搭配的满意程度评价。

POST / comment HTTP1.1
Content-Type: application/x-www-form-urlencoded

请求参数

字段属性说明
weatherinteger温度
labelstring穿搭标签
scoreinteger评分

返回结果

返回信息：

成功时：
HTTP/1.1 200 OK

失败时(例子)：
HTTP/1.1 403 Forbidden
Content-Type: application/x-www-form-urlencoded
{"message" : "未收到评价"}


4. 天气模块

4.1 获取天气信息

接口说明

从“易源数据”获取天气信息。

GET / weather HTTP1.1
Content-Type: application/json

请求参数

参考易源提供的API



数据库与算法部分的数据对接

说明

从数据库获取当前用户所有衣物的信息，然后处理为算法模块需要的格式，通过传参的形式传给算法。
算法执行后返回搭配结果。

传给算法

数据格式

[
  {
    "cloid": integer,	// 衣物id
    "code": integer,	//色彩码，1-26
	"colortype":integer,//颜色种类 颜色种类：1:non 2:warm 3:cold)
    "type": integer,			//衣物属性：种类 1短袖 2长袖 3毛衣 4棉服 5夹克 6西装外套 7连衣裙 8半身裙 9裤子
    "clothlength": integer,		//衣物属性：长度 1短 2中 3长
    "tightness": integer,		//衣物属性：松紧 1紧 2宽
    "thi": integer				//衣物属性：薄厚 1薄 2中 3厚
  },...
]

算法传回

选取的衣物信息格式

[
  {//workdtata, sportdata, datedata
    "cloid":integer,			//衣物id 
    "type": integer,			//衣物属性：种类 1短袖 2长袖 3毛衣 4棉服 5夹克 6西装外套 7连衣裙 8半身裙 9裤子
    "clothlength": integer,		//衣物属性：长度 1短 2中 3长
    "tightness": integer,		//衣物属性：松紧 1紧 2宽
    "thi": integer,				//衣物属性：薄厚 1薄 2中 3厚
    "code": integer	//色彩码，1-26
  },...
]

tips信息格式：

[
  {//workdtips, sporttips, datetips
    "style": integer,	// 标签：1工作 2约会 3运动
    "tips": string	//小贴士内容
  },...
]
萝卜ヽ
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
后端接口文档例子 word
03-18
"后端接口文档详解" 在本文档中，我们将详细介绍后端接口文档的编写，特别是Java接口文档的编写。通过本文档，我们将了解后端接口文档的重要性、编写格式、请求参数、返回参数等方面的知识点。 一、为什么需要后端...
后端接口调试软件
12-13
这是一款非常实用的后端接口调试工具，方便快捷，包含restful风格的接口测试请求。
Spring Boot 后端接口规范大全，告别混乱代码
m0_71777195的博客
06-24 1393
一个后端接口大致分为四个部分组成：接口地址（url）、接口请求方式（get、post等）、请求数据（request）、响应数据（response）。虽然说后端接口的编写并没有统一规范要求，而且如何构建这几个部分每个公司要求都不同，没有什么“一定是最好的”标准，但其中最重要的关键点就是看是否规范。一个接口一般对参数（请求数据）都会进行安全校验，参数校验的重要性自然不必多说，那么如何对参数进行校验就有讲究了。一般来说有三种常见的校验方式，我们使用了最简洁的第三种方法业务层校验。
Spring Boot如何设计优雅的后端接口
qq_45917176的博客
06-23 1421
使用Spring Boot设计后端接口
Swagger接口文档 —— 手把手教学，全方位超详细小白能看懂，百分百能用Java版
最新发布
dream_ready的博客
04-18 1901
使用Swagger你只需要按照它的规范去定义接口及接口相关的信息，就可以做到生成接口文档，以及在线接口调试页面。官网：https://swagger.io/是为Java MVC框架集成Swagger生成Api文档的增强解决方案。
编写后端接口步骤
路小飞
04-21 6407
后端接口书写步骤
通宵整理：后端接口优化的14个技巧！
田维常
07-03 1285
你好，我是田哥。最近，有很多盆友找我咨询后端接口优化问题，主要也应该是现在前后端分离比较多，导致很多人就只知道干后端的活，所以就想着把后端的接口油画起来。在实际项目中，当越来越多对性能的吐槽反馈到我们这里的时候，我们意识到，接口性能的问题的优先级必须提高了。然后我们就跟踪了1周的接口性能监控，这个时候我们的心情是这样的：有20多个慢接口，5个接口响应时间超过5s，1个超过...
前后端分离项目-后端接口入门开发手记
jl15988
11-01 5326
在我们的业务逻辑中，可能需要自定义异常来抛出，由全局异常处理类来处理，这个时候考虑到返回的状态码和异常信息的不同，我们需要自定义异常类来配合全局异常处理在com.myblog包下创建common.lang包，并创建MyBlogException类，如下/**super(msg);super(msg);super(msg);} }然后我们就可以使用自定义的异常类来抛出异常了，如修改list接口。
微商城后端接口项目包含API接口说明文档等
06-15
微商城后端接口项目，包含服务器搭建说明，所需的软件以及API接口说明文档
使用httpie调试后端接口
01-07
http PUT api.example.com/person/1 \ name=John \ age:=29 married:=false hobbies:='[http, ... description=@about-john.txt \ # Embed text file bookmarks:=@bookmarks.json # Embed JSON file ... person.json ...
后端接口通用开发流程.png
04-23
适合新手或初级后端的接口开发思路
什么是接口文档，如何写接口，有什么规范？
前端工程师，博文都是自己学习到的，或者开发中遇到的点，记录一下
04-02 3415
一、什么是接口文档？ 在项目开发中，web项目的前后端分离开发，APP开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。 二、为什么要写接口文档？ 1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发 2、项目维护中或者项目人员更迭，方便后期人员查看、维护 三、接口规范是什么？ 首先接口分为四部分：方法、uri、请求参数、返回参数 1、方法:新增(post) 修改(put) 删除(delete) 获取(get) 2.
Swagger(一) Swagger/Springfox 入门简介
奥迪的博客
09-12 7261
Swagger/Springfox 入门简介 一、 Swagger 简介 1 前言 接口文档对于前后端开发人员都十分重要。尤其近几年流行前后端分离后接口文档又变成重中之重。接口文档固然重要，但是由于项目周期等原因后端人员经常出现无法及时更新，导致前端人员抱怨接口文档和实际情况不一致。 很多人员会抱怨别人写的接口文档不规范，不及时更新。当时当自己写的时候确实最烦去写接口文档。这种痛苦只有亲身经历才会牢记于心。 如果接口文档可以实时动态生成就不会出现上面问题。 Swagger 可以完美的解决上面..
前后端分离必备的接口规范，十分接地气！
Java技术栈，分享最主流的Java技术
07-19 4637
Java技术栈www.javastack.cn优秀的Java技术公众号作者：猿码道https://www.jianshu.com/p/c81008b683501. 前言随...
Swagger介绍及使用
热门推荐
Django的博客
01-28 1万+
Swagger介绍及使用 Swagger Codegen: 通过Codegen 可以将描述文件生成html格式和cwiki形式的接口文档，同时也能生成多钟语言的服务端和客户端的代码。支持通过jar包，docker，node等方式在本地化执行生成。也可以在后面的Swagger Editor中在线生成。 Swagger UI:提供了一个可视化的UI页面展示描述文件。接口的调用方、测试、项目经理等都可以...
后端开发常说的接口是指什么
bjjx123456的博客
05-04 478
那么我们常说的编写后端接口值的是哪个呢，我觉得应该是前面哪个，因为我们并不是去实现接口，而是去继承servlet接口的实现类的子类的子类的。所以是指写好的用来处理请求的函数，在springboot中每个请求对应一个函数。java中的接口的含义前面有说过，有两个，一个指的是api（就是写好的函数），一个是java的接口。
软件测试之接口文档
m0_68405758的博客
05-05 1133
在项目期间，前后端是分离开发的，为了前后有连贯性，就必须由前后开发工程师共同定义接口、写接口文档再根据接口文档去开发，一直到项目结束。
接口测试 —— 接口和接口文档概念
05-11 610
1、接口的概念，接口又叫API，全称application programming interface：应用程序接口（规范），也就是我们经常会听说Web接口，APP接口。详细说明：APP是一种基于C/S架构的应用程序，如抖音、微信等。完整的体验是基于APP客户端和后台云服务端共同作用的结果。 客户端和服务端的数据传递，也就是指客户端向服务端发送请求，服务端响应客户端的过程。 这一系列的通讯都是基于web协议通讯构成的，在利用web协议通讯的时候，企业内通常都会规
java后端接口是干什么的_【后端开辟】java中抽象类和接口有什么区别？
weixin_30827827的博客
02-26 484
在java中笼统类和接口都是用于完成笼统的，那末它们之间有什么区分？下面本篇文章就来给人人引见一下。有肯定的参考价值，有须要的朋侪能够参考一下，愿望对人人有所协助。 笼统类笼统类是用来捕获子类的通用特征，即配合点的；比方：汽车、自行车、电瓶车，它们都是车子，能够有一个配合的笼统类：Vehicle 。笼统类不能被实例化，不能用来建立对象，只能用作子类的超类。接口接口是笼统要领的鸠合。假如一个类完成了...
nginx后端接口404
10-09
对于nginx后端接口返回404错误的问题，可能有以下几个原因和解决方法： 1. 检查请求的URL是否正确：确认请求的URL是否拼写正确且指向正确的路由。可以在浏览器中直接访问该URL，看是否能够正常访问。 2. 检查nginx...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值