与你相遇好幸运，aglio写接口文档
npm install -g aglio
npm i aglio-theme-minimal
aglio --theme-full-width -t minimal -i ./src/index.md -o index.html
FORMAT: 1A
HOST: http://123.56.205.244:8602/event/
# Common Demo Interface Plan
后端 `Demo` 通用接口计划
# Group Event Manage
农事管理
## Event [/event]
有关农事の增删改查
### Create [POST /{fields,from,time,type,system,details}]
农事的增加接口
+ Parameters
+ fields: `111` (string) - 地块的ID
+ from: `admin` (number) - 农事记录增加者
+ time: `2016-11-11T15:45:01.000Z` (string) - 农事的时间
+ type: `bbb` (number) - 农事的类型
+ system: `shuye` (number) - Deom系统
+ details: `{"amount:1"}` (number) - 农事具体信息
+ Response 200 (application/json)
+ Body
{
"status": 1,
"message": "creeate",
"result": {
"fields": "111",
"from": "admin",
"time": "2016-11-11T15:45:01.000Z",
"type": "bbb",
"system": "shuye",
"details": {
"amount": 1
},
"create": "2016-11-14T02:38:14.528Z",
"id": "58292396f4a4802026629e40"
}
}
### Desoroy [DELETE /{id}]
农事的删除接口
+ Parameters
+ id: `58292396f4a4802026629e40` (number)
+ Response 200 (application/json)
+ Body
{
"status": 1,
"message": "ok",
"result": {
"fields": "111",
"from": "admin",
"time": "2016-11-11T15:45:01.000Z",
"type": "bbb",
"system": "shuye",
"details": {
"amount": 1
},
"create": "2016-11-14T02:38:14.528Z",
"id": "58292396f4a4802026629e40"
}
}
### Update [PUT /{id}/{?fields,?from,?time,?type,?system,?details}]
农事的更新接口
+ Parameters
+ id: `582593c110e80b0435c59907` (string) - 农事的ID
+ fields: `5825936f10e80b0435c59906` (string,optional) - 地块的ID
+ from: `admin` (number,optional) - 农事记录增加者
+ time: `2016-11-11T15:45:01.000Z` (string) - 农事的时间
+ type: `bbb` (number,optional) - 农事的类型
+ system: `SYSTEM` (number,optional) - Deom系统
+ details: `{"amount":100}` (number,optional) - 农事具体信息
+ Response 200 (application/json)
+ Body
{
"status": 1,
"message": "ok",
"result": {
"fields": "5825936f10e80b0435c59906",
"from": "admin",
"time": "2016-11-11T15:45:01.000Z",
"type": "bbb",
"system": "SYSTEM",
"details": {
"amount": 100
},
"create": "2016-11-11T09:47:45.468Z",
"id": "582593c110e80b0435c59907"
}
}
### Find [GET /{?limit,?skip}]
农事的查找接口
+ Parameters
+ limit: `2` (number,optional)
+ skip: `1` (string,optional)
+ Response 200 (application/json)
+ Body
{
"status": 1,
"message": "ok",
"result": [
{
"fields": "111",
"from": "admin",
"time": "2016-11-11T15:45:01.000Z",
"type": "aaa",
"system": "shuye",
"details": {
"amount": 66
},
"create": "2016-11-11T09:46:23.736Z",
"id": "5825936f10e80b0435c59906"
},
{
"fields": "5825936f10e80b0435c59906",
"from": "admin",
"time": "2016-11-11T15:45:01.000Z",
"type": "bbb",
"system": "SYSTEM",
"details": {
"amount": 100
},
"create": "2016-11-11T09:47:45.468Z",
"id": "582593c110e80b0435c59907"
}
]
}
### FindOne [GET /{id}/]
农事的查找接口
+ Parameters
+ id: `5825936f10e80b0435c59906` (string) - 农事的ID
+ Response 200 (application/json)
+ Body
{
"status": 1,
"message": "ok",
"result": {
"fields": "111",
"from": "admin",
"time": "2016-11-11T15:45:01.000Z",
"type": "aaa",
"system": "shuye",
"details": {
"amount": 66
},
"create": "2016-11-11T09:46:23.736Z",
"id": "5825936f10e80b0435c59906"
}
}
与你相遇好幸运，aglio写接口文档的更多相关文章
- 「快学springboot」16.让swagger帮忙写接口文档
swagger简介 官方的介绍 THE WORLD'S MOST POPULAR API TOOLING Swagger is the world's largest framework of API ...
- Markdown写接口文档，自动添加TOC
上回说到,用Impress.js代替PPT来做项目展示.这回换Markdown来做接口文档好了.(不敢说代替Word,只能说个人感觉更为方便)当然,还要辅之以Git,来方便版本管理. Markdown ...
- 研发团队如何写好API接口文档
导读 背景 痛点在哪? 为什么要写接口文档? API规范 接口工具 总结 背景 随着业务的发展,支撑组的项目也是越来越多.同时,从整个支撑组项目架构体系(含运维和运营体系),我们对系统业 ...
- Swagger解决你手写API接口文档的痛
首先,老规矩,我们在接触新事物的时候, 要对之前学习和了解过的东西做一个总结. 01 痛 苦 不做.不行 之前,前后端分离的系统由前端和后端不同的编写,我们苦逼的后端工程师会把自己已经写完的A ...
- 基于swagger进行接口文档的编写
0. 前言 近期忙于和各个银行的代收接口联调,根据遇到的问题,对之前编写的接口进行了修改,需求收集和设计接口时想到了方方面面,生产环境下还是会遇到意想不到的问题,好在基本的执行逻辑已确定,因此只是对接 ...
- [日常] 编写HTTP接口文档
一.什么是接口文档?在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护.二.为什么要写接口 ...
- 接口文档神器--apiui的使用
接口开发,最麻烦的就是写文档了,曾经我也因为写接口文档苦不堪言:自从使用了apiui接口文档神器,工作效率和文档清晰得到了不止一个档次的提升. 下面介绍一下这个神器的使用: 把文件下载下来,放在网站根 ...
- PCB WebAPI 接口测试工具与接口文档生成
我们自己写WebAPI或调用对方系统提供的WebAPI时,测试WebAPI接口工具用哪些工具呢. 这里将3种WebAPI常用到的工具使用说明.主要是讲对第3种WebApiTestClientWebAp ...
- Api接口文档管理工具，你知道哪些呢？
上周看到有人在我的Github开源项目中提了个issue,说是否考虑接入swagger.那今天我就用swagger与其他接口文档工具做对比,同时说说Api接口文档工具的那点事.如今,在前后端分离开发的 ...
随机推荐
- 我的第一篇blog
加入博客园两年多了,学习.从事编程也两年多了,一直是在网上找资料,都没有认真写写博客. 博客园里面好多功能都还不会用,今天起我也要在博客园写自己的blog了.感觉很高大上的样纸!!
- console.log((function f(n){return ((n > 1) ? n * f(n-1) : n)})(5))调用解析
console.log((function f(n){) ? n * f(n-) : n)})()); 5被传入到函数,函数内部三元计算,5 > 1成立,运算结果是5*f(4),二次运算,5*4 ...
- php-fpm中启用慢日志配置（用于检测执行较慢的PHP脚本）
虽然通过nginx accesslog可以记录用户访问某个接口或者网页所消耗的时间,但是不能清晰地追踪到具体哪个位置或者说函数慢,所以通过php-fpm慢日志,slowlog设置可以让我们很好的看见哪 ...
- 刚开始用git遇到的无法提交变更的问题
原来我在目录里打开命令行,git bash默认执行的目录是c:/users了,错误的使用了git init,把$HOME 路径下的所有文件载入 git 仓库了,删除$HOME 路径下的".g ...
- ED2k Resource
http://www.lwkk.com/ http://www.ed2000.com/
- MySQL中日期与时间类型
http://blog.sina.com.cn/s/blog_4d8730df01014jiy.html
- Linux(Centos6.5)用户名密码
用户列表文件:/etc/passwd用户组列表文件:/etc/group 查看系统中有哪些用户:cut -d : -f 1 /etc/passwd查看可以登录系统的用户:cat /etc/passwd ...
- 轻松理解spring IOC
spring IOC(Inversion of control)即控制反转 概念:一,spring框架的核心之一 二,控制权由对象本身转向容器:由容器根据配置文件去创建实例并创建各个实例之间的依赖关系 ...
- es_Linux
命令:echo 显示.印出 echo $PATH 通过 "su - vbird"" 这个指令来变换到 vbird身份 权限: rwx rwx rwx 以4 2 1数字表 ...
- 关于学习angularJS 的 心里路程(二)
这一次主要的学习内容是 ng-route(本次的项目由于种种原因吧,我们采用了ui-router,而不是原生的ng-route) * 配置路由. * 注意这里采用的是ui-router这个路由,而不是 ...