后台接口设计

* 本页面总结凯冰科技第一版APP的后台接口设计相关内容。

凯冰科技网关接口

根据简易的 产品PRD文档 ,共计需要接口文档如下:

接口总计:24个

后台接口BaseURI:**.zkbhj.com

后台接口协议:HTTPS/2

接口加密:AES与RSA混合加密

后台排期:2021年2月8日~2月9日

技术方案:Go(v1.16) + gin框架(v1.6.3)

其他选型:MySQL数据库,Redis作为缓存,zap日志包,凯冰科技静态资源中心(ZKSC)提供静态资源支持,凯冰科技API中心(ZKAPIC)提供核心公共接口支持

1、首页接口
  • URL:{BaseURI}/app/music/default.json
  • 请求方式:GET
  • 功能描述:返回首页相关数据
2、歌单列表
  • URL:{BaseURI}/app/music/sheet-list.json
  • 请求方式:GET
  • 功能描述:返回歌单列表数据
3、专辑列表
  • URL:{BaseURI}/app/music/album-list.json
  • 请求方式:GET
  • 功能描述:返回专辑列表数据
4、歌手列表
  • URL:{BaseURI}/app/music/singer-list.json
  • 请求方式:GET
  • 功能描述:返回歌手列表数据
5、榜单列表
  • URL:{BaseURI}/app/music/top-list.json
  • 请求方式:GET
  • 功能描述:返回榜单列表数据
6、我的喜欢列表
  • URL:{BaseURI}/app/music/favorite-list.json
  • 请求方式:GET
  • 功能描述:返回我的喜欢列表数据
7、搜索接口
  • URL:{BaseURI}/app/music/search.json
  • 请求方式:GET
  • 功能描述:返回搜索结果数据
8、音频详情接口
  • URL:{BaseURI}/app/music/song-detail.json
  • 请求方式:GET
  • 功能描述:返回音频详情数据(音乐地址、歌词、头像等)
9、歌手详情接口
  • URL:{BaseURI}/app/music/singer-detail.json
  • 请求方式:GET
  • 功能描述:返回歌手详情数据
10、专辑详情接口
  • URL:{BaseURI}/app/music/album-detail.json
  • 请求方式:GET
  • 功能描述:返回专辑详情数据
11、歌单详情接口
  • URL:{BaseURI}/app/music/sheet-detail.json
  • 请求方式:GET
  • 功能描述:返回歌单详情数据
12、榜单详情接口
  • URL:{BaseURI}/app/music/top-detail.json
  • 请求方式:GET
  • 功能描述:返回榜单详情数据
13、添加/取消喜欢接口
  • URL:{BaseURI}/app/music/like.json
  • 请求方式:POST
  • 功能描述:添加/取消喜欢歌曲

* 本页内容参考以下数据源:

  • https://www.cnblogs.com/huanzi-qch/p/10913636.html
  • https://blog.csdn.net/ityouknow/article/details/80603617
  • https://gin-gonic.com/

凯冰科技 · 代码改变世界,技术改变生活
下一篇:前端环境搭建 →