API项目接口文档

用户注册接口

  • 请求URL:

http://127.0.0.1:8000/api/v1/register

  • 请求方式:Post
  • 参数名必选
    用户名username
    类型CharField

IntegerField
用户类型(会员非会员)

password
CharField
密码

gender
IntegerField
性别

birthday
DateTimeField
出生日期

登录接口

请求URL:

参数:
user
OneToOneField
用户名

password
CharField
密码

login_time
DateTimeField
登录时间

token
字符串
用户登录后唯一标识

分类接口

请求URL:

http://127.0.0.1:8000/api/v1/category/

  • 请求方式:
    GET

参数:

name

CharField
分类名称

add_time
DateTimeField
添加时间

Id
IntegerField
分类ID

书籍列表接口

参数

bookName
CharField
要添加的书名字

status
IntegerField
书籍所处状态,默认已完结

author
CharField
书籍作者

biaoQian
CharField
标签

info
CharField
书籍简介

category
ForeignKey
所属书籍分类

add_time
DateTimeField
添加时间

category
ForeignKey(外键)
1表示一个分类,说明这个书籍要添加的到这个分类下面的
简要表述 书籍详情接口

请求URL

http://127.0.0.1:8000/api/v1/bookdetail/1/

  • 请求方式:
    GET

书籍章节列表

请求URL
http://127.0.0.1:8000/api/v1/chpater/1/
请求方式:
GET

chpaterName
CharField
章节名称

books
ForeignKey(外键)
所属书籍

isVip
BooleanField
是否设为VIP章节
默认为false

True为设为VIP

False不设为VIP

章节详情接口

请求URL

http://127.0.0.1:8000/api/v1/chpaterdetail/1/

  • 请求方式
    GET
    参数

字段类型

chpaterName

CharField

章节名称

content
TextField
章节内容

books
ForeignKey

isVip
BooleanField
是否是VIP章节

add_time
DateTimeField
设置添加时间

发表评论接口

请求URL

http://127.0.0.1:8000/api/v1/comment/?token=424de112861bc49e90ef1cf51ea25224

  • 请求方式

POST

参数
User

ForeignKey
评论用户和用户表关联

content
TextField
评论内容

comment_book
ForeignKey
要评论哪本书,和书籍ID关联

评论列表接口
  • 请求URL

http://127.0.0.1:8000/api/v1/commentlist/1/

  • 请求方式
    GET

参数
User
ForeignKey
评论用户和用户表关联

content
TextField
评论内容

comment_book
ForeignKey
要评论哪本书,和书籍ID关联

add_time
DateTimeField
添加时间

根据书籍ID去获取用户评论

删除列表接口

请求URL

http://127.0.0.1:8000/api/v1/deletelist/4/?token=424de112861bc49e90ef1cf51ea25224

请求方式

DELETE

根据评论ID删除

加入书籍接口

请求URL

http://127.0.0.1:8000/api/v1/bookstand/?token=424de112861bc49e90ef1cf51ea25224
请求方式
POST

参数

users
ForeignKey
用户ID和用户表关联

Shuji
ForeignKey
要放入书籍的ID和书籍列表关联

书架展示接口

请求URL

http://127.0.0.1:8000/api/v1/bookstandlist/1/?page=1&token=424de112861bc49e90ef1cf51ea25224

请求方式
GET

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。