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
- MarkDown 书写 接口文档(Haroopad 编辑器)
- 离线markdown编辑器Haroopad介绍
- Markdown编辑器中改变图片尺寸(eg:haroopad)
- Haroopad--最好用的markdown编辑器
- 试用MarkDown标记法和Haroopad编辑器
- Haroopad 最好用的Markdown 编辑器
- Haroopad语法小结-----markdown编辑器推荐
- 用markdown编辑器写技术接口文档
- Haroopad Markdown 编辑器代码语法高亮支持
- [置顶] linux上靠谱免费的markdown编辑器haroopad
- Markdown之haroopad语法
- 接口说明文档书写格式
- CSDN-markdown编辑器文档
- Markdown编辑数学公式:Haroopad + MathJax
- markdown使用haroopad导出PDF
- MarkDown 编辑器相关使用文档
- CSDN-markdown编辑器操作文档
- CSDN-markdown编辑器帮助文档
- Android——自定义View(学习Android开发与艺术探索)
- Android 进出activity的滑动动画效果
- Java 合并word
- 随笔-开发小笔记之代码架构和规范
- 【Zookeeper系列五】ZooKeeper 实时更新server列表
- MarkDown 书写 接口文档(Haroopad 编辑器)
- maven用途、核心概念、用法、常用参数和命令、扩展
- OpenCV mean-shift和camshift跟踪
- linux 内核定时器 timer_list / mod_timer/init_timer
- Android 用Animation-list实现逐帧动画
- iOS 简单快速开发图片轮播器(第三方SDCycleScrollView)
- 【Zookeeper系列六】Zookeeper 工作原理
- java.lang.ClassNotFoundException: org.apache.commons.dbcp.BasicDataSource
- SPI-Flash