Code Monkey home page Code Monkey logo

markdownapi's Introduction

接口文档示例

类型 服务器地址
Test http://xxx.xxx.xxx:xxx
Develop http://xxx.xxx.xxx:xxx
Product http://xxx.xxx.xxx:xxx

用户模块

接口 请求方式 说明
/user POST 用户登录
/user GET 获取用户详情

接口详情

  • 登录接口

    • 接口地址:/user

    • 返回格式:Json

    • 请求方式:Post

    • 请求示例:/user

    • 接口备注:用户登录。

    • 请求参数说明:

      名称 类型 必填 说明
      username string true 用户名
      password string true 用户密码
    • JSON请求示例:

         "Header":{
             "token": "",
         }
          "Body":{
             "username": "",
             "password": "",
         }  
      
    • 返回参数说明:

      名称 类型 说明
      code int 状态码
      data object 具体数据
      token string 登录方式
    • JSON返回示例:

         {
             "code": 200,
             "data": {
                 "token": "1234567890",
             }
         }
      

  • 获取用户详情

    • 接口地址:/user

    • 返回格式:Json

    • 请求方式:Post

    • 请求示例:/user

    • 接口备注:通过用户信息,请求获得全局策略。

    • 请求参数说明:

      名称 类型 必填 说明
      Header true 请求报文头
      token string true 用户登录后token,没有登录则为空字符串
      ------ ------ ----- ------
      username string true 用户名
      password string true 用户密码
    • 返回参数说明:

      名称 类型 说明
      code int 状态码
      data object 具体数据
      username string 用户名
      phone string 手机号
      sex int 性别:0-未知、1-男、2-女
    • JSON返回示例:

         {
             "code": 200,
             "data": {
                 "username": "1234567890",
                 "phone": "1234567890",
                 "Sex":1,
             }
         }
      

响应码说明

响应码 说明
200 处理成功
301 解析报文错误
302 无效调用凭证
303 参数不正确
500 系统内部错误
999 处理失败

markdownapi's People

Contributors

nacker avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.