1. 程式人生 > >xxx專案介面文件模板

xxx專案介面文件模板

分享一下我老師大神的人工智慧教程!零基礎,通俗易懂!http://blog.csdn.net/jiangjunshow

也歡迎大家轉載本篇文章。分享知識,造福人民,實現我們中華民族偉大復興!

               

 

XXX專案介面

 

 

 

 

 

 

 

               

版本

編寫人員

備註

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

1   站點資訊介面

1.1      介面描述

         查詢填報單位資訊及欄目資訊

1.2      介面引數

提交路徑:

測試:http://ip:8080/urlxxx

正式內網:http://ip:9080/urlxxx

請求方式:POST/GET

引數說明:

                 

引數名稱

預設值

範圍

備註說明

Key1

 

xxx

Key2

 

xxxx

1.3      返回樣例

{

 "hasPrev": false,

 "pageTotal": 1,

 "hasNextPage": null,

 "pageSize": 25,

 "pageNo": 1,

 "recordSize": 1,

 "hasNext": false,

 "data": [

    {

     "key1": "1100000205",

     "key2": null,

      "list": [

       {

         "key1": "1100000205",

         "key2": null

        },

      ],

     "key3": 1479363148000,

     "key3": "林琳"

    }

  ]

}

 

1.4      返回欄位說明

站點資訊:

             

引數名稱

引數說明

範圍

Key1

首頁url

Key2

Xxxx

欄目資訊:

           

引數名稱

引數說明

範圍

Key3

描述

 

Key4

Xxx欄位

 

 


           

給我老師的人工智慧教程打call!http://blog.csdn.net/jiangjunshow

這裡寫圖片描述