美文网首页
API项目接口文档

API项目接口文档

作者: 骚X | 来源:发表于2019-07-24 10:02 被阅读0次

用户注册接口

  • 请求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

相关文章

  • 2018年大四生产实习接口文档

    六. 后端接口文档 6.1 接口文档说明 由于该项目为前后端分离项目且接口符合 RESTful API 规范,项目...

  • 项目 api 接口文档

    项目接口文档my-blog 一、先定义所有接口,返回的参数规范。 结构体: {"status": 0,"msg":...

  • API项目接口文档

    用户注册接口 请求URL: http://127.0.0.1:8000/api/v1/register 请求方式:...

  • document

    xyh2018_api_documents 项目介绍 用于存放、维护校友会项目的接口文档。各种文档主要使用Mark...

  • Vue应用框架整合与实战--前后端分离后的开发模式篇

    开发流程 后台编写和维护接口文档,在 API 变化时更新接口文档 后台根据接口文档进行接口开发 前端根据接口文档进...

  • 接口API文档

    erp项目或者其他开发项目,或多或少都会接触到关于接口的任务,可能是编写接口api文档,也可能是调用接口。无论是写...

  • 美食杰项目API接口文档

    1. 查询指定项目属性 接口功能 获取美食杰项目的下的分类信息 URL https://m.meishij.net...

  • 个人微信开发api

    个人微信开发api,微信开发api文档,微信api接口文档 case "HeartBeatReq": {// 客户...

  • 微信开发者api

    微信api接口接入,微信群api接口,微信api接口文档,微信开发者api微信消息api case DeviceA...

  • 2018-05-09

    项目api的封装 前端项目的数据来源都是经过接口获取,所以一份好的api文档尤为重要,能让我们项目后期的维护更加方...

网友评论

      本文标题:API项目接口文档

      本文链接:https://www.haomeiwen.com/subject/ahetrctx.html