1. 程式人生 > >SosoApi使用說明-基本操作文件

SosoApi使用說明-基本操作文件

一、SosoApi基本操作

1、建立一個新專案


點選後彈出輸入框,輸入專案的名字。


開啟:緊表明專案目前狀況,只有開啟和關閉兩種狀態。

點選儲存,會自動跳轉到專案列表頁,就能看到我們剛剛建立的Soso專案。


在這裡說明一下:

退出:是自己看不到這個專案了,而被新增到這個專案裡的其他成員還是能看到的。

複製:沒用過。

刪除:指的是刪除專案本身,刪除後項目中的所有成員都看不到,只有管理員才有該許可權,慎用。

2、編輯專案的基本資訊


3、專案成員操作

點選專案成員,可以看到加入到這個專案中所有的成員列表


邀請成員分為兩種

直接新增,可以設定成員的角色(管理員或者訪客


還可以通過郵件新增


注意:

成員列表中的編輯是不能夠修改暱稱的。


進入到編輯頁面


這裡只能修改的角色(管理員或訪客),而且只有管理員才有許可權修改。

如需修改個人的暱稱,需要到個人中心去修改

4、關於專案變更

(1)包括變更通知和變更歷史


列表中每個頁面的右上角,都有變更通知,點選,都會出現,變更通知頁面


沒什麼可說了,裡邊直接填寫,或者限定給誰傳送變更通知,內容的各種形式,都在這裡填寫。

(2)變更歷史

就是傳送變更的時候,所有選擇儲存到變更歷史裡邊的所有變更。

進入的頁面


可以很方便我們翻閱以前什麼時候,做了什麼操作。

5、API文件資訊

訪問主機,可配置為外網,區域網或本機ip,因為測試是基於本地的ajax請求, 所以只要API所在伺服器處理好跨域請求都支援網站線上測試API。


在這裡最主要的就是設定好根路徑。

6、模組管理

步驟說明
主要用於對API介面進行分類,可以不設定,預設全部在"default"組下面。


注意事項
API文件預覽展示的模組順序為升序,如需按要求排序可在模組名稱前加序號指定。

模組管理頁面


新增和編輯的頁面是一樣的


定義模組的名稱和權重,對這個模組加以描述

7、介面管理

首先我們要新增介面


進入介面新增輸入頁面


填寫完成,並儲存,返回介面管理列表頁面


點選名稱或者後邊的編輯,都可以對我們的介面進行編輯。

進入編輯頁面。頁面分為三部分。基本資訊,請求資訊,響應資訊

(1)基本資訊



(2)請求資訊

步驟說明
1.引數位置說明如下:

body:http請求body

cookie:本地cookie

formData:表單引數

header:http請求header

path:http請求url,如getInfo/{userId}

query:http請求拼接,如getInfo?userId={userId}

2.引數型別說明如下:

參考"編輯資料結構"步驟中的引數型別說明

自定義:目前僅支援自定義json格式,僅當"引數位置"為“body"有。

在我工作總我一般都用query,query型別在請求的時候,引數直接拼接到訪問路徑的後邊

頁面


點選更多,可以設定預設值,還有說明。


在頁面新增完成,並儲存,在預覽中看到的結果出現在這裡


(3)響應資訊

步驟說明

1.資料型別說明如下:

參考"編輯資料結構"步驟中的引數型別說明

自定義:目前僅支援自定義json格式,僅當"引數位置"為“body"有效。

2.注意事項

指定預設響應時,只需將響應"編碼"設定為"default"即可。

首先新增響應資訊

我用到的定義響應資訊有兩種

第一,

型別選擇自定義,把需要返回的json格式,定義到這個裡邊,完成

第二,

引用資料型別(ref),所引用的資料型別在資料結構中定義。

定義完成在介面中顯示的位置為


8、資料結構定義

首先新增資料結構,提供給上邊的介面進行引用。


進入新增頁面


欄位可以是單型別欄位,也可以引用其他定義的欄位。