美文网首页
接口声明

接口声明

作者: 任笙_8b8c | 来源:发表于2020-07-15 20:45 被阅读0次

约定

出错情况返回 Result()对象
参数: false,状态码信息,出错描述信息.
正确情况返回 Result()对象
参数: true,状态码信息,正确描述信息

添加品牌

请求地址:

post http://192.168.200.128:9001/brand

请求参数说明

参数 类型 必填 说明
brand json 是 封装品牌参数的对象

POST 数据示例：

{
"name":"张三"
}

结果参数说明:

参数 类型 说明
flag boolean 返回状态
code int 返回状态码
message string 返回信息描述
data Object 返回参数

返回结果示例：

{
    "flag": true,
    "code": 20000,
    "message": "添加成功",
    "data": null
}

添加用户

请求地址:

post http://localhost:9101/system/admin

\color{red}{特别注意:}

我们每一次请求都会先经过网关,网关的filter过滤器会对携带的令牌进行解析
如果解析成功才放行,所以必须携带一个含key,value的头信息(对应的key会有过期时间,先登录再操作)

参数 类型 必填 说明
key String 是 headers的请求头的key
value String 是 headers的请求头的value

Headers头数据示例

key:token
value: eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI2MDg2Y2FkYS1hZjU2LTQ5MmItOTc2OC05OWRmYmMwOGRiYTAiLCJzdWIiOiLnvo7lpbPkuIDlj7ciLCJpc3MiOiJhZG1pbiIsImlhdCI6MTU5NDk4NzAzMSwiZXhwIjoxNTk0OTkwNjMxfQ.guITcmB2azBjhBO2rai5O-ehFPOmVJ_OsGoASDh69uw

请求参数说明

参数 类型 必填 说明
Admin json 是 封装品牌参数的对象

POST 数据示例：

{
"loginName":"美女二号","password":"123456"
}
[{
"key":"token",
"value":"eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI2MDg2Y2FkYS1hZjU2LTQ5MmItOTc2OC05OWRmYmMwOGRiYTAiLCJzdWIiOiLnvo7lpbPkuIDlj7ciLCJpc3MiOiJhZG1pbiIsImlhdCI6MTU5NDk4NzAzMSwiZXhwIjoxNTk0OTkwNjMxfQ.guITcmB2azBjhBO2rai5O-ehFPOmVJ_OsGoASDh69uw","description":"","type":"text","enabled":true
}]

返回结果参数说明:

参数 类型 说明
flag boolean 返回状态
code int 返回状态码
message string 返回信息描述
data Object 返回参数
token string 返回的唯一令牌

返回结果示例：

{
    "flag": true,
    "code": 20000,
    "message": "登录成功",
    "data": {
        "username": "美女一号",
        "token": "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJlOTBjZjg4MS05ZjdkLTQzZTItOWI0Ny0xZTY3NGMwOGE1ODgiLCJzdWIiOiLnvo7lpbPkuIDlj7ciLCJpc3MiOiJhZG1pbiIsImlhdCI6MTU5NDk4NTkyNiwiZXhwIjoxNTk0OTg5NTI2fQ.3dV3cTPQE7orYk4_nWmUeFnbv54HKF0E4OfIxuvgLZg"
    }
}

用户登录

请求地址:

post http://localhost:9101/system/admin/login

请求参数说明

参数 类型 必填 说明
Admin json 是 封装品牌参数的对象

POST 数据示例：

{"loginName":"美女一号","password":"123456"}

返回结果参数说明:

参数 类型 说明
flag boolean 返回状态
code int 返回状态码
message string 返回信息描述
data Object 返回参数
token string 返回的唯一令牌

返回结果示例：

{
    "flag": true,
    "code": 20000,
    "message": "登录成功",
    "data": {
        "username": "美女一号",
        "token": "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJlOTBjZjg4MS05ZjdkLTQzZTItOWI0Ny0xZTY3NGMwOGE1ODgiLCJzdWIiOiLnvo7lpbPkuIDlj7ciLCJpc3MiOiJhZG1pbiIsImlhdCI6MTU5NDk4NTkyNiwiZXhwIjoxNTk0OTg5NTI2fQ.3dV3cTPQE7orYk4_nWmUeFnbv54HKF0E4OfIxuvgLZg"
    }
}

_spu_sku列表添加

请求地址:

post http://localhost:9101/goods/spu

\color{red}{特别注意:}

我们每一次请求都会先经过网关,网关的filter过滤器会对携带的令牌进行解析
如果解析成功才放行,所以必须携带一个含key,value的头信息(对应的key会有过期时间,先登录再操作)

参数 类型 必填 说明
key String 是 headers的请求头的key
value String 是 headers的请求头的value

Headers头数据示例

key:token
value: eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI2MDg2Y2FkYS1hZjU2LTQ5MmItOTc2OC05OWRmYmMwOGRiYTAiLCJzdWIiOiLnvo7lpbPkuIDlj7ciLCJpc3MiOiJhZG1pbiIsImlhdCI6MTU5NDk4NzAzMSwiZXhwIjoxNTk0OTkwNjMxfQ.guITcmB2azBjhBO2rai5O-ehFPOmVJ_OsGoASDh69uw

请求参数说明

参数 类型 必填 说明
Goods json 是 封装_spu_sku列表参数的对象

POST 数据示例：

{"spu":{"name":"这个是商品名称",      
        "caption":"这个是副标题","brandId":12,
        "category1Id":558,"category2Id":559,  
        "category3Id":560, "freightId":10   ,  
        "image":"http://www.changgou.com/image/1.jpg" ,"images":"http://www.changgou.com/image/1.jpg,http://www.changgou.com/image/2.jpg",
        "introduction":"这个是商品详情，html代码",
         "paraItems":"{"出厂年份":"2019","赠品":"充电器"}", "saleService":"七天包退,闪电退货",
        "sn":"020102331","specItems":"{"颜色":["红","绿"],"机身内存":["64G","8G"]}",
        "templateId":42},"skuList":[{ "sn":"10192010292","num":100, "alertNum":20,"price":900000,"spec":"{"颜色":"红","机身内存":"64G"}",
        "image":"http://www.changgou.com/image/1.jpg",
        "images":"http://www.changgou.com/image/1.jpg,http://www.changgou.com/image/2.jpg" ,
        "status":"1","weight":130},{ "sn":"10192010293","num":100,"alertNum":20,"price":600000,"spec":"{"颜色":"蓝","机身内存":"128G"}",
        "image":"http://www.changgou.com/image/1.jpg","images":
        "http://www.changgou.com/image/1.jpg,http://www.changgou.com/image/2.jpg" , "status":"1",
        "weight":130}]}

返回结果参数说明:

参数 类型 说明
flag boolean 返回状态
code int 返回状态码
message string 返回信息描述
data Object 返回参数

返回结果示例：

{
    "flag": true,
    "code": 20000,
    "message": "添加成功",
    "data": {
        "null"
    }
}

根据id查询商品

请求地址:

GET localhost:9101/goods/spu/10000000616300

\color{red}{特别注意:}

我们每一次请求都会先经过网关,网关的filter过滤器会对携带的令牌进行解析
如果解析成功才放行,所以必须携带一个含key,value的头信息(对应的key会有过期时间,先登录再操作)

参数 类型 必填 说明
key String 是 headers的请求头的key
value String 是 headers的请求头的value

Headers头数据示例

key:token
value: eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI2MDg2Y2FkYS1hZjU2LTQ5MmItOTc2OC05OWRmYmMwOGRiYTAiLCJzdWIiOiLnvo7lpbPkuIDlj7ciLCJpc3MiOiJhZG1pbiIsImlhdCI6MTU5NDk4NzAzMSwiZXhwIjoxNTk0OTkwNjMxfQ.guITcmB2azBjhBO2rai5O-ehFPOmVJ_OsGoASDh69uw

请求参数说明

参数 类型 必填 说明
id int 是 用于查询数据的id

POST 数据示例：

返回结果参数说明:

参数 类型 说明
flag boolean 返回状态
code int 返回状态码
message string 返回信息描述
data Object 返回参数

返回结果示例：

{
    "flag": true,
    "code": 20000,
    "message": "查询成功",
    "data": {
        "spu": {
            "id": "10000000616300",
            "sn": "",
            "name": "巴布豆(BOBDOG)柔薄悦动婴儿拉拉裤XXL码80片(15kg以上)",
            "caption": "纤薄升级，透气不闷，舒适大环腰，宝宝随心动更多优惠猛戳",
            "brandId": 3834,
            "category1Id": 1099,
            "category2Id": 1117,
            "category3Id": 1124,
            "templateId": 44,
            "freightId": 0,
            "image": "https://m.360buyimg.com/mobilecms/s450x450_jfs/t23998/350/2363990466/222391/a6e9581d/5b7cba5bN0c18fb4f.jpg!q70.jpg.webp",
            "images": "https://m.360buyimg.com/mobilecms/s450x450_jfs/t23998/350/2363990466/222391/a6e9581d/5b7cba5bN0c18fb4f.jpg!q70.jpg.webp",
            "saleService": "",
            "introduction": "<img src='https://img30.360buyimg.com/sku/jfs/t1/10519/22/6556/290804/5c21a000E0a66fb27/f1a6441c4f740325.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t1/25877/1/2773/300826/5c219ff3E77ebceec/0cb798cf689a66f0.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t17638/48/1391313768/42002/a407aefe/5ac9d2a4Nb1dcb498.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t26878/241/1898666367/253089/d18ab92/5bf26555N7d227bf1.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t27610/157/1922753389/258405/91a20217/5bf26b81N312702c1.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t28114/198/389456860/78549/6e7062e3/5bf26555N1b029da0.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t26872/173/1899243857/187100/8749d59d/5bf26555N62e9bfd0.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t26176/265/1923351581/151877/a59eefd8/5bf26555Ne3e998d2.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t30562/341/391648780/74732/1124670a/5bf26555N0419c2fd.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t30370/351/385752786/64471/2c823536/5bf26555N48f1559d.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t28294/235/394081724/184949/6326934/5bf26555N82160908.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t28180/228/405295577/85683/50144232/5bf26555Nec2ba510.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t26143/251/1915817557/119944/821fbe1f/5bf26555N1fe60c86.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t27658/178/1923277913/159317/2680cd1d/5bf26b81Nb722f447.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t27736/190/1876550793/64771/36907034/5bf26b81N1038823a.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t28276/141/414889658/161123/cf9eed3f/5bf26b81N9b81be3e.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t26359/262/1904587765/74623/4a55697f/5bf26556N2882b58e.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t27022/186/1927495197/172735/7711959a/5bf26556N9d779fc5.jpg'><br/><img src='https://img30.360buyimg.com/sku/jfs/t1/2381/18/9116/213698/5bab595aE71e4edcf/b005cfee4e558f08.jpg'>",
            "specItems": "{\"规格\":[\"88片\",\"80片\",\"104片\",\"96片\"]}",
            "paraItems": "",
            "saleNum": 0,
            "commentNum": 0,
            "isMarketable": "1",
            "isEnableSpec": "1",
            "isDelete": "0",
            "status": "1"
        },
        "skus": []
}
}

根据id查询商品

请求地址:

put localhost:9101/goods/spu/audit/10000000616300

\color{red}{特别注意:}

我们每一次请求都会先经过网关,网关的filter过滤器会对携带的令牌进行解析
如果解析成功才放行,所以必须携带一个含key,value的头信息(对应的key会有过期时间,先登录再操作)

参数 类型 必填 说明
key String 是 headers的请求头的key
value String 是 headers的请求头的value

Headers头数据示例

key:token
value: eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI2MDg2Y2FkYS1hZjU2LTQ5MmItOTc2OC05OWRmYmMwOGRiYTAiLCJzdWIiOiLnvo7lpbPkuIDlj7ciLCJpc3MiOiJhZG1pbiIsImlhdCI6MTU5NDk4NzAzMSwiZXhwIjoxNTk0OTkwNjMxfQ.guITcmB2azBjhBO2rai5O-ehFPOmVJ_OsGoASDh69uw

请求参数说明

参数 类型 必填 说明
id int 是 用于查询数据的id

POST 数据示例：

返回结果参数说明:

参数 类型 说明
flag boolean 返回状态
code int 返回状态码
message string 返回信息描述
data Object 返回参数

返回结果示例：

{
    "flag": true,
    "code": 20000,
    "message": "商品审核成功",
    "data": null
}
}

相关文章

  • 接口声明

    接口:在TypeScript中，接口是用作约束作用的，在编译成JavaScript的时候，所有的接口都会被擦除掉，...

  • 接口声明

    约定 出错情况返回 Result()对象参数: false,状态码信息,出错描述信息.正确情况返回 Result(...

  • typescript接口声明

    typescript 检查变量类型的时候其中采用的一个方法是“鸭子类型判断法” "所谓鸭子类型判断法也就是指看起来...

  • TypeScript(四)接口和类的区别

    接口只声明成员方法，不做实现。类声明并实现方法。 接口就是用于声明函数的，然后在类中去实现这些接口里的函数。 那么...

  • 第三章②接口

    接口（interface）是与类并行的一个概念 接口声明格式：interface接口名 类声明格式：class类名...

  • Kotlin学习笔记（三）接口

    1.接口 在kotlint中和java类似，接口的声明使用interface来声明，而不同的是kotlin中的接口...

  • java中的内部接口

    内部接口也被称为嵌套接口，这意味着在另一个接口内声明一个接口。 例如，Entry接口声明在Map接口中。 为什么要...

  • 测试需要掌握的http协议知识

    一、开发与测试眼中的接口 开发眼中的接口 （1）Interface关键字用来声明一个接口。下面是接口声明的一个简单...

  • Java8值函数式接口

    Java8值函数式接口 如果一个接口中，只声明了一个抽象方法，则此接口就称为函数式接口 在接口上声明@Functi...

  • 接口

    回到目录项目源码 kotlin-class 项目 使用 interface 声明一个接口, 接口里可以声明抽象方法...

网友评论

      本文标题：接口声明

      本文链接：https://www.haomeiwen.com/subject/vcwjhktx.html

      延伸阅读

      深度阅读

      • 您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

      栏目导航

      热点阅读

      关于我们|服务条款|联系我们|接口声明|投稿指南|网站地图|RSS订阅|排版工具|手机版

      提供经典美文摘抄,优美散文欣赏,现代诗歌精选,短篇小说,心情随笔,表白情书范文,故事会在线阅读欣赏

      Copyright © 2014-2023 Haomeiwen.com All Rights Reserved. 好美文阅读网 版权所有

      备案信息：桂公网安备 45052102000051号 · 桂ICP备13007215号-3

      本站所收录作品、热点评论等信息部分来源互联网，目的只是为了系统归纳学习和传递资讯

      所有作品版权归原创作者所有，与本站立场无关，如不慎侵犯了你的权益，请联系我们告知，我们将做删除处理！