• 基于asp.net core webapi的商品管理系统Api开发(二)登录功能Api


    基础知识

    一 同一状态码200响应格式

    http状态码无条件统一为200,表示服务器处理请求了

    http状态码为其他比如201,404,500,都是非正常的处理

    响应数据=code+msg+data

    [code]=(-1=失败|1=成功|2=其他成功)

    [msg]=[当code=-1时输出错误信息]

    [data]=[(当code=1是才会返回。可以是对象,数组,字符串,数字)]

    客户端使用时统一处理非200的状态错误,200状态的根据code做业务处理。

     二 Restful风格使用http状态码做响应

    查询时=(状态码200=成功|400=请求参数有问题|404=没有找到对象)+(200直接返回数据对象或数组|400返回字符串错误信息|404返回空)

    插入时=(状态码201=成功|400=请求参数有问题)+(201直接返回数据对象|400返回字符串错误信息)

    修改时=(状态码204=成功|400=请求参数有问题)+(204直接返回空修改成功|400验证返回字符串错误信息|404返回空)

    删除时=(状态码200=成功|404=未找到)+(200直接返回被修改对象|400验证返回字符串错误信息|404返回空)

    客户端使用时不能统一处理非200的状态错误,要具体根据状态,确定内容数据

    功能分析

     用例=登录

    Usecase=Login

    [输入流]=[登录表单]=[用户名+密码]

    [Input]=[LoginInput]=[UseName+Password]

    [输出流]=[登录结果对象]=[是否正确+token值]

    [Output]=[LoginOuput]=[IsOk+Token]+(IsOk=true时Token才有值表示成功,IsOk=false时表示登录失败)

    接口定义

    请求路径:/Login

    请求方法:Post

    请求参数:

      用户名:UseName:不能为空

      密码:Password:不能为空

    响应参数:

      用户Id:Id:整形

      用户名:UserName:字符串

      手机号:Mobile:手机号格式

      用户角色Id:RoleId:整形

      Token

    代码

  • 相关阅读:
    java资料
    tomcat内存配置
    mybatis深入理解(一)之 # 与 $ 区别以及 sql 预编译
    Sturts2的国际化处理
    web.xml中如何设置配置文件的加载路径
    varchar和varchar2的区别
    IDEA 常见文件类型的图标介绍
    IDEA文件编码修改
    Debug 介绍
    IntelliJ IDEA 显示行号方法
  • 原文地址:https://www.cnblogs.com/xiewenyu/p/13126494.html
Copyright © 2020-2023  润新知