Nola
    Nola
    • 后台 API
      • 配置
        • 初始化博客信息
        • 初始化管理员
        • 修改博客信息
        • 获取博客信息
        • 修改备案信息
        • 获取备案信息
      • 管理员
        • 管理员登录
        • 登录有效性
        • 获取管理员信息
        • 修改管理员信息
        • 修改管理员密码
      • 标签
        • 添加标签
        • 删除标签 - ID
        • 删除标签 - 别名
        • 修改标签
        • 获取标签 - ID
        • 获取标签
      • 分类
        • 添加分类
        • 删除分类 - ID
        • 删除分类 - 别名
        • 修改分类
        • 获取分类 - ID
        • 获取分类
      • 文章
        • 文章相关
          • 添加文章
          • 删除文章
          • 回收文章
          • 恢复文章
          • 修改文章
          • 修改状态
          • 获取文章 - ID
          • 获取文章 - 别名
          • 获取文章
          • 获取文章正文和草稿
        • 文章正文
          • 修改文章正文
          • 获取文章正文
        • 文章草稿
          • 添加文章草稿
          • 删除文章草稿
          • 修改文章草稿
          • 修改文章草稿名
          • 将草稿转为正文
          • 获取文章草稿
      • 友情链接
        • 添加友情链接
        • 删除友情链接
        • 修改友情链接
        • 获取友情链接
      • 菜单
        • 菜单
          • 添加菜单
          • 删除菜单
          • 修改菜单
          • 获取菜单
        • 菜单项
          • 添加菜单项
          • 删除菜单项
          • 修改菜单项
          • 获取菜单项
      • 日记
        • 添加日记
        • 删除日记
        • 修改日记
        • 获取日记
      • 文件
        • 存储策略
          • 所有存储策略
          • 设置腾讯云对象存储
          • 获取腾讯云对象存储
          • 删除腾讯云对象存储
        • 文件组
          • 添加文件组
          • 删除文件组
          • 修改文件组
          • 获取文件组
        • 文件
          • 添加文件
          • 删除文件 - ID
          • 删除文件 - 文件名
          • 移动文件
          • 获取文件
      • 备份
        • 导入文章
        • 导出文章
      • 评论
        • 添加评论
        • 删除评论
        • 修改评论
        • 通过审核
        • 获取评论
      • 操作记录
        • 删除操作记录 - ID
        • 删除全部记录
        • 删除时间前的记录
        • 获取操作记录
      • 概览
        • 博客概览数据
    • 博客 API
      • 配置
        • 获取博客信息
        • 获取备案信息
      • 博主
        • 获取博主信息
      • 标签
        • 获取标签
      • 分类
        • 获取分类
      • 文章
        • 获取所有文章
        • 获取文章内容
        • 获取文章 - ID
        • 获取文章 - 别名
      • 友情链接
        • 获取友情链接
      • 菜单
        • 获取菜单项
      • 日记
        • 获取日记
      • 评论
        • 添加评论
        • 获取评论
    • 快捷 API
      • 获取博客 LOGO
        GET
      • 获取博客 Favicon
        GET

    后台 API

    Nola

    注意事项#

    博客的 API 接口具有严格的参数类型安全和合法性检测,并区分大小写。请务必按照 API 文档提示的参数类型传参,否则都将会返回 409 - 请求参数不匹配 错误,包括但不限于:
    1.
    要求整型,实际字母
    2.
    枚举类匹配异常(如:要求 A 或 B,但提供 C)

    一、枚举类#

    本系统中,除了一些必要的参数,其他的所有值都使用枚举类进行传参和接收,建议你在开发时也创建对应的枚举类,避免出现魔法值。各枚举类定义,请详见各模块接口的父文件夹文档。

    二、接口响应#

    1.响应体结构#

    本系统中所有接口的响应都遵循如下基本格式:
    {
        code: 200,
        errMsg: null,
        data: null
    }
    对应的 Kotlin 类如下:

    2.响应代码#

    正常情况下,会响应以下五种 Http 状态代码:
    200 - OK
    409 - Conflict
    401 - Unauthorized
    429 - Too Many Requests
    500 - InternalServerError
    200 代表本次请求成功。
    409 为自定义错误响应,本系统中所有自定义错误都将以该响应代码返回,如:账号密码错误,标签别名重复等等,通常情况下,错误的信息会在 errMsg 中,可以直接将该错误信息提示给用户。
    401 为未授权请求,以下几种情况会响应该代码:
    在未登录(请求没有附带 Token 令牌)的情况下访问有权限的接口。
    登录过期。
    429 为请求太频繁,在一些敏感的接口上会有此限制,等待一定时间恢复。
    500 为未知错误,请检查服务器日志。在服务端非预期的异常都会返回该代码。
    在正常使用情况下,出现 401 错误代码,就代表当前登录已经过期,需要重新登录。
    修改于 2024-03-04 11:17:07
    下一页
    配置
    Built with