与你相遇好幸运，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接口文档工具的那点事.如今,在前后端分离开发的 ...
随机推荐
- 【bzoj1227】 SDOI2009—虔诚的墓主人
http://www.lydsy.com/JudgeOnline/problem.php?id=1227 (题目链接) 题意 一个n*m的公墓,一个点上要么是墓地,要么是常青树,给出一个数K,并规定每 ...
- 编程结构：Promise和Future
非阻塞模型中Promise,Future 和 Callback一些比较常用的模型: Future表示一个可能还没有实际完成的异步任务结果:实际在编程中,应用future数据结构的时候,你得到并不是一个 ...
- Vue.JS 对比其他框架
Angular 选择 Vue 而不选择 Angular,有下面几个原因,当然不是对每个人都适合: 在 API 与设计两方面上 Vue.js 都比 Angular 简单得多,因此你可以快速地掌握它的全部 ...
- IntelliJ IDEA 常用设置讲解
说明 IntelliJ IDEA 有很多人性化的设置我们必须单独拿出来讲解,也因为这些人性化的设置让我们这些 IntelliJ IDEA 死忠粉更加死心塌地使用它和分享它. 常用设置 IntelliJ ...
- LINQ驱动数据的查询功能
一.LINQ概念 LINQ是微软在.NetFramework3.5中新加入的语言功能,在语言中以程序代码方式处理集合的能力. 1.1 LINQ VS 循环处理 在我刚工作时候,对于集合对象的处理一般是 ...
- [NHibernate]延迟加载
目录 写在前面 文档与系列文章 延迟加载 一个例子 总结 写在前面 上篇文章介绍了多对多关系的关联查询的sql,HQL,Criteria查询的三种方式.本篇文章将介绍nhibernate中的延迟加载方 ...
- PHP利用P3P实现跨域
本文转自:点这里 有别于JS跨域.IFRAME跨域等的常用处理办法,还可以利用P3P来实现跨域. P3P是什么 P3P(Platform for Privacy Preferences)是W3C公布的 ...
- （转载）JavaWeb学习总结(五十三)——Web应用中使用JavaMail发送邮件
博客源地址:http://www.cnblogs.com/xdp-gacl/p/4220190.html 现在很多的网站都提供有用户注册功能, 通常我们注册成功之后就会收到一封来自注册网站的邮件.邮件 ...
- jquery numberbox赋值
numberbox不能使用$('#id').val( '');只能使用$('#id').numberbox('setValue','');
- jquery和dom之间的转换
刚开始学习jquery,可能一时会分不清楚哪些是jQuery对象,哪些是DOM对象.至于DOM对象不多解释,我们接触的太多了,下面重点介绍一下jQuery,以及两者相互间的转换. 什么是jQuery对 ...