22 如何編寫介面文件

2022-05-01 08:45:06 字數 1319 閱讀 6119

使用者登入介面

介面位址

localhost:8000/login

請求方式

post

引數名描述

引數型別

是否必填

username

使用者名稱string

是password

密碼string

建立部落格介面

介面位址

localhost:8000/add_article

請求方式

post

引數名描述

引數型別

是否必填

最大長度限制

id部落格id

int否

title

部落格標題

string是10

author

部落格作者

string是10

content

部落格內容

string

是500

使用者修改部落格介面

介面位址

localhost:8000/modify_article

請求方式

post

引數名描述

引數型別

是否必填

最大長度限制

id部落格id

int是

title

部落格標題

string是10

author

部落格作者

string是10

content

部落格內容

string

是500

使用者根據標題查詢部落格介面

介面位址

localhost:8000/get_article

請求方式

get引數名

描述引數型別

是否必填

title

部落格標題

string

使用者刪除部落格介面

介面位址

localhost:8000/delete_article

請求方式

post

引數名描述

引數型別

是否必填

id部落格id

int是

之前已經提到過,我們測試介面的時候,一般是增刪改查以及登入是這五種,所以這裡簡單寫了乙個demo,涵蓋了以上5種。

如何編寫介面文件

乙個簡單的介面文件,寫完給組長看後,發現漏洞百出。下面總結一下寫文件需要注意事項 封面最好是本公司規定的封面,有logo,內容標題,版本號,公司名稱,文件產生日期。錯誤地方在於,文件的標題要和頁首中的標題一致 形式較好些。包括,版本,修訂說明,修訂日期,修訂人,審核時間審核人。我錯誤的地方在於,中其...

如何規範編寫介面文件

編寫乙份基本的介面文件要注意以下幾點 1.一定要有版本號,因為基本上對應的介面都是剛開發或者待開發的 已經正常使用的介面也不需要你來寫文件 不可能一次提供最終版,方便後續更改,同時避免因為修改多次導致雙方使用不一樣的文件而出錯。2.要有目錄和時間 建立時間,修改時間 3.介面文件最重要的是介面的詳細...

16 如何編寫介面文件

使用者登入介面 介面位址 localhost 8000 login 請求方式 post 引數名描述 引數型別 是否必填 username 使用者名稱string 是password 密碼string 是 建立部落格介面 介面位址 localhost 8000 add article 請求方式 pos...