与你相遇好幸运，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接口文档工具的那点事.如今,在前后端分离开发的 ...
随机推荐
- django static文件的引入方式
1. 在django project中创建 static文件夹 2.settings.py中配置要在 STATIC_URL = '/static/' 下边 STATICFILES_DIRS = [ ...
- hover 变内容
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/ ...
- redis-windows免安装版本安装多个redies
1.复制两份redis:端口分别为6369和6379 2.修改端口 6379为redis默认的端,不改; 进入6369的下面找到如下配置文件: redis.conf 修改端口 然后分别启动redis- ...
- pod setup 安装的最新办法（大坑啊）
由于升级到10.11以后安装cocodpods难免会碰到各种问题,下面有列举出不同的解决办法,建议一个方法如果不行,把文件请了再用第二种方法, 流程是这样的:正常安装-->碰到问题-->查 ...
- angular指令深度学习篇
angular指令深度学习-过滤器 limitTo ... <body ng-app="app" > <div ng-controller="myCtr ...
- 这些年MAC下我常用的那些快捷键
Command + H:隐藏窗口 Command + M:最小化窗口 Command + N:新建 Command + O:打开 Command + S:保存 Command + shift+S:另存 ...
- 如何阅读Java源码 阅读java的真实体会
刚才在论坛不经意间,看到有关源码阅读的帖子.回想自己前几年,阅读源码那种兴奋和成就感(1),不禁又有一种激动. 源码阅读,我觉得最核心有三点:技术基础+强烈的求知欲+耐心. 说到技术基础,我打个比 ...
- sublime2使用jshint
合理配置Jshint可以帮助写出高质量的代码,通过sublime2插件 JSHint Gutter 可以迅速提供开发效率和减少bug的个数. 1.安装JSHint Gutter插件 sublime2按 ...
- struts2 s:file标签使用及文件上传例子
<s:form action="uploadaction" method="post" enctype="multipart/form-da ...
- css 实现三角形 实现过程
1.纯色的全等的三角形实现 下面的就是实际实现 没有宽高 只有边框 都是透明 根据箭头的方向 给边框方法加颜色 比如需要像右箭头 只需要给border-right-color:颜色值; 即可 c ...