1. 程式人生 > >2017年5月26日 20:56:11

2017年5月26日 20:56:11

-c script 描述 spa key name inpu cnblogs 人的

  自己寫api文檔。

  不要自負的認為自己不需要文檔,你不需要別人需要啊。看了一個月的別人的接口文檔,今天學著自己動手寫api文檔。

  api文檔最重要的包括:

  接口名 言簡意賅 GetActivityModel

  接口作用 再次翻譯一下上面接口名字是什麽意思

  接口參數:input

元素 類型 是否必須 名稱 描述
ID int 必須 userID 用戶唯一主鍵 primary key
prefession
name string 必須 prefessionName 職業名稱
isDimission bool 必須 isDimission 是否離職

  接口返回值:output一般為xml 或者 json數據 當然也可以返回自定義數據

  栗子:

{
    "user": {
        "name": "白求恩",
        "country": "canada",
        "pary": "共*產*黨"
    },
    "prefwssionList": [
        {
            "prefwssion": {
                "address": "南京西路",
                "wages": "12000",
                "name": "藥房醫生"
            }
        },
        {
            "prefwssion": {
                "address": "南京路",
                "wages": "9000",
                "name": "夜勤醫生"
            }
        },
        {
            "prefwssion": {
                "address": "司馬光路",
                "wages": "15000",
                "name": "兒科醫生"
            }
        }
    ]
}

  

2017年5月26日 20:56:11