首页 > 代码库 > 2017年5月26日 20:56:11

2017年5月26日 20:56:11

2024-09-26 07:39:02   297人阅读

　　自己写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


联系
我们