MarkDown 书写 接口文档(Haroopad 编辑器)

来源:互联网 发布:潮州淘宝客服招聘 编辑:程序博客网 时间:2024/05/14 15:05

1. 用MarkDown 语言编写接口文档,有以下几种好处

    1. 纯文本编写,可将接口文档交于SVN等管理,能清晰记录接口文档变更

    2. 接口文档有样式,便于阅读


2. 示例


3. 源代码:

# 用户注册接口文档### 1. 用户注册查询【前台】**接口地址**: /frnt/user/save.json**请求对象**: BaseOperationRequest< UserVO >**响应对象**: BaseOperationResponse< Long  >**参数校验**: 用户名,密码均不能为空**接口描述**: 用户注册,供前台调用**Auth-date**:[add by XXX 2016-5-26]#####请求格式:```json{"requestObject":{"username":"",//用户名"password":"",//用户密码"age":1 //年龄}//请求对象}```#####返回格式:```json{"messageCode":"1",//错误代码(成功为1)"responseObject":{1},//返回对象"messageDescription":"error",//错误信息"responseError":[{"message":"null",//提示信息"fieldName":"name",//字段名"rejectedValue":1//错误值}]//验证错误内容}```#####请求示例:```json{"requestObject":{"username":"zhangsan","password":"123456",//用户密码"age":1 //年龄}//请求对象}```#####响应示例:```json{"messageCode":"1",//错误代码(成功为1)"responseObject":{1},//返回对象"messageDescription":"error",//错误信息"responseError":[{"message":"null",//提示信息"fieldName":"name",//字段名"rejectedValue":1//错误值}]//验证错误内容}```***



0 0
原创粉丝点击