3.接口约定

·  阅读 48

约定接口6个

约定6个接口:
1.路由
2.类型
3.提交参数的格式
4.字段
5.成功的数据格式
6.失败的数据格式

复制代码

约定接口一般包括以下数据

  1. (路由)当前接口的路径是什么? 如 /auth/register

  2. 当前接口提交数据的类型是什么? 如

    • GET 获取数据
    • POST 提交或者创建
    • PATCH 修改数据,部分修改
    • DELETE 删除数据
    • PUT 修改数据,整体替换原有数据
  3. 参数类型/格式,比如是 json 格式,还是 application/x-www-form-urlencoded的数据

  4. 参数字段,及限制条件

  5. 返回成功的数据格式

  6. 返回失败的数据格式

认证相关

POST /auth/register

功能: 用户注册

提交参数

-   参数类型:`Content-Type: application/x-www-form-urlencoded;charset=utf-8`

-   参数字段

    -   `username` : 用户名, 长度115个字符,只能是字母数字下划线中文
    -   `password` : 密码, 长度616个任意字符

返回数据

-   失败

    -   状态码 400
    -   返回格式 `{msg: '错误原因'}`

-   成功

    -   状态码 200
    -   返回格式

复制代码

GET /auth

功能: 判断用户是否登录

提交参数: 无

返回数据
复制代码

GET /auth/logout

复制代码

POST /auth/login

笔记本

GET /notebooks

POST /notebooks

PATCH /notebooks/:notebookId

DELETE /notebooks/:notebookId

笔记

POST /notes/to/:notebookId'

GET /notes/from/:notebookId

DELETE /notes/:noteId

PATCH /notes/:noteId

DELETE /notes/:noteId/confirm

PATCH /notes/:noteId/revert

GET /notes/trash

分类:
前端
标签:
分类:
前端
标签:
收藏成功!
已添加到「」, 点击更改