前后端开发接口文档模板(登录、注册、项目发布与需求发布)
生活随笔
收集整理的這篇文章主要介紹了
前后端开发接口文档模板(登录、注册、项目发布与需求发布)
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
接口列表
| UserRegister | 用戶注冊 | [ TODO ] |
| UserLogin | 用戶登錄 | [ TODO ] |
| PublishProjects | 發布項目 | [ TODO ] |
| ReleaseRequirements | 發布需求 | [ TODO ] |
用戶注冊 (UserRegister)
**請求樣例: **
"data": {"user_name": "xxx","password": "xxx","password_confirm": "xxx","phone": "111111111"}**參數說明: **
| user_name | string | 是 | 用戶名 |
| password | string | 是 | 用戶密碼,需要加密處理 |
| password_confirm | string | 是 | 用戶密碼確認,需要加密處理 |
| phone | string | 是 | 用戶手機號碼 |
**返回樣例: **
{"msg": "success","code": 200 }**參數說明: **
| msg | string | 返回注冊結果 |
| code | string | 返回操作結果代碼 |
用戶登錄 (UserLogin)
**請求樣例: **
"data": {"user_name": "xxx","password": "xxx"}**參數說明: **
| user_name | string | 是 | 用戶名 |
| password | string | 是 | 用戶密碼,需要加密處理 |
**返回樣例: **
{"msg": "success","code": 200 }**參數說明: **
| msg | string | 返回登錄結果 |
| code | string | 返回操作結果代碼 |
發布項目(PublishProjects)
**請求樣例: **
{"title": "XXXXXX","context": "XXXXXXXXXXXXXXXXXXXXXXX","project_type": "XXXXX","money": "10000","user_name": "XXX","user_industry": "XXXXXX","phone": "1111111111","contact": "XXXXX","address": "XXXXXX","user_id": 1 }**參數說明: **
| title | string | 是 | 項目名 |
| context | string | 是 | 項目詳細內容 |
| project_type | string | 是 | 項目類別 |
| money | string | 是 | 項目意向金額 |
| user_name | string | 是 | 項目發布人用戶名 |
| user_industry | string | 是 | 項目發布人所屬行業 |
| phone | string | 是 | 項目發布人聯系電話 |
| contact | string | 是 | 項目發布人聯系途徑 |
| address | string | 是 | 項目發布人所屬地 |
| user_id | int | 是 | 項目發布人用戶id |
**返回樣例: **
{"msg": "success","code": 200 }**參數說明: **
| msg | string | 返回項目發布結果 |
| code | string | 返回操作結果代碼 |
發布需求(Release requirements)
**請求樣例: **
{"title": "XXXXXX","context": "XXXXXXXXXXXXXXXXXXXXXXX","project_type": "XXXXX","money": "10000","employer_name": "XXX","employer_industry": "XXXXXX","phone": "1111111111","contact": "XXXXX","address": "XXXXXX","ddl": "XXXXXX","user_id": 1 }**參數說明: **
| title | string | 是 | 需求名 |
| context | string | 是 | 需求詳細內容 |
| project_type | string | 是 | 需求項目類別 |
| money | string | 是 | 意向金額 |
| user_name | string | 是 | 需求發布人用戶名 |
| user_industry | string | 是 | 需求發布人所屬行業 |
| phone | string | 是 | 需求發布人聯系電話 |
| contact | string | 是 | 需求發布人聯系途徑 |
| address | string | 是 | 需求發布人所屬地 |
| ddl | string | 是 | 需求完成期限 |
| user_id | int | 是 | 需求發布人用戶id |
**返回樣例: **
{"msg": "success","code": 200 }**參數說明: **
| msg | string | 返回項目發布結果 |
| code | string | 返回操作結果代碼 |
總結
以上是生活随笔為你收集整理的前后端开发接口文档模板(登录、注册、项目发布与需求发布)的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: VM虚拟机不能上网的问题解决
- 下一篇: 查看IIS连接数