码迷,mamicode.com
首页 > 其他好文 > 详细

22. 接口文档

时间:2019-06-12 16:39:35      阅读:91      评论:0      收藏:0      [点我收藏+]

标签:描述   text   请求   type   ready   ade   mes   str   header   

登录

接口描述

用户登录接口

接口地址

接口地址 localhost:8000/login
请求方式 POST

请求参数

参数名 描述 参数类型 是否必填
username 用户名 String
password 密码 String

返回值

{'status': 1, 'message': 'login success'}
{'status': 0, 'message': 'username or password null'}
{'status': 0, 'message': 'username or password error'}
{'status': 0, 'message': 'request type error'}

创建博客

接口描述

创建博客接口

接口地址

接口地址 localhost:8000/add_article
请求方式 POST

请求参数

参数名 描述 参数类型 是否必填 最大长度限制
id 博客id Int
title 博客标题 String 10
author 博客作者 String 10
content 博客内容 String 500

返回值

{'status': 0, 'message': 'id or title or author or content null'}
{'status': 0, 'message': "参数类型错误"}
{'status': 0, 'message': 'article id already exists'}
{'status': 0, 'message': "创建博客失败"}
{'status': 1, 'data': data, 'message': 'add article success'}
{'status': 0, 'message': 'request type error'}

修改博客

接口描述

用户修改博客接口

接口地址

接口地址 localhost:8000/modify_article
请求方式 POST

请求参数

参数名 描述 参数类型 是否必填 最大长度限制
id 博客id Int
title 博客标题 String 10
author 博客作者 String 10
content 博客内容 String 500

返回值

{'status': 0, 'message': 'id or title or author or content null'}
{'status': 0, 'message': "参数类型错误"}
{'status': 0, 'message': 'article not exist'}
{'status': 0, 'message': "修改博客失败"}
{'status': 1, 'data': data, 'message': 'modify article success'}
{'status': 0, 'message': 'request type error'}

查询博客

接口描述

用户根据标题查询博客接口

接口地址

接口地址 localhost:8000/get_article
请求方式 GET

请求参数

参数名 描述 参数类型 是否必填
title 博客标题 String

返回值

{'status': 1, 'message': 'login success'}
{'status': 0, 'message': 'username or password null'}
{'status': 0, 'message': 'username or password error'}
{'status': 0, 'message': 'request type error'}

删除博客

接口描述

用户删除博客接口

接口地址

接口地址 localhost:8000/delete_article
请求方式 POST

请求参数

参数名 描述 参数类型 是否必填
id 博客id Int

返回值

{'status': 0, 'message': 'id null'}
{'status': 0, 'message': "参数类型错误"}
{'status': 0, 'message': 'id not exist'}
{'status': 0, 'message': '删除博客失败'}
{'status': 1, 'message': 'delete article success'}
{'status': 0, 'message': 'request type error'}

之前已经提到过,我们测试接口的时候,一般是增删改查以及登录是这五种,所以这里简单写了一个demo,涵盖了以上5种。

22. 接口文档

标签:描述   text   请求   type   ready   ade   mes   str   header   

原文地址:https://www.cnblogs.com/suim1218/p/11010378.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!