22.インタフェースドキュメントの作成方法

ログイン
インタフェースの説明
ユーザーログインインタフェース
インタフェースアドレス
インタフェースアドレス
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'}

前にも述べたように、インタフェースをテストするとき、一般的には添削とログインがこの5種類なので、ここでは簡単にdemoを書いて、以上の5種類をカバーしています.
転載先:https://www.cnblogs.com/suim1218/p/11010378.html