美文网首页
项目接口文档描述

项目接口文档描述

作者: Ropynn | 来源:发表于2019-01-04 11:16 被阅读0次

接口返回统一格式

{
  "code": 0,  //0表示成功  其他的状态码待商议
  "data": {  
    
  }
}

用户注册

类型 post

参数名 类型 是否为空 含义 默认值
username str 不能为空 登录名
password str 不能为空 密码
token str 不能为空 用户token
avatar str 可以为空 用户头像
name str 不能为空 名称
roles str 不能为空 规则 ["visitor"]
正常返回
{
  "code": 0
}

用户登录

类型 post

参数名 类型 是否为空 含义 默认值
username str 不能为空 用户名
password str 不能为空 密码
正常返回
{
  "code": 0,
  "data": {
    "username": "", //用户名
    "password": "", //密码
    "token": "",    //token
    "avatar": ""    //头像
    "name": "",     //姓名
    "roles": []     //用户权限
  }
}

相关文章

  • 项目接口文档描述

    接口返回统一格式 用户注册 类型 post 正常返回 用户登录 类型 post 正常返回

  • 2018年大四生产实习接口文档

    六. 后端接口文档 6.1 接口文档说明 由于该项目为前后端分离项目且接口符合 RESTful API 规范,项目...

  • python 项目-后台接口文档字段翻译

    后台接口文档格式如下: 数据库文档格式如下数据库文档.png 最后得到翻译完成的接口文档 项目地址

  • 使用SwaggerUI生成接口文档(配示例)

    SwaggerUI 接口文档 在项目开发中,接口文档一直是个头疼的问题。本来项目开发时间就紧张,还需要另外写文档给...

  • 吐槽接口文档(二)——什么是优秀的接口文档

    昨天说了合格的接口文档,今天继续唠一唠,什么是我觉得优秀的接口文档。 项目部分 首先,优秀的接口文档在合格的接口文...

  • Swagger UI初识

    新项目使用Swagger UI自动生成接口文档,不需要频繁更新接口文档,保证接口文档与代码的一致,值得学习。本文记...

  • 【融职培训】Web前端学习 第9章 教务管理系统开发3 接口文档

    一、接口文档简介 在项目开发中,web项目的前后端分离开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家...

  • llog-24 会说话吗?

    昨天的项目,除了一些页面修改,剩下的 bug 都是文档描述不准备或者接口错误导致的,虽然很无语,但意识到文档不是绝...

  • 在线生成接口文档

    接口文档是项目开发中必需的说明文档,接口文档编写有很多不同的方式,今天本文简单介绍一下常用的几种接口文档编写方法。...

  • 前端多人协作

    作为项目负责人,多人协作,各种坑爹状况收录。 项目接口文档 项目接口文档一定需要,不然完全丢失了前后端分离的优势。...

网友评论

      本文标题:项目接口文档描述

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