与你相遇好幸运，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接口文档工具的那点事.如今,在前后端分离开发的 ...
随机推荐
- C#稳固基础：传统遍历与迭代器
Hello,Coders.我们除了天天的码 if…else…之外,还会不断的码出foreach.我今天要说的是:传统遍历需实现的接口及我们还有一种更简洁优雅的方式实现多种迭代器. 传统遍历 传统的遍历 ...
- Spring AOP动态切换数据源
现在稍微复杂一点的项目,一个数据库也可能搞不定,可能还涉及分布式事务什么的,不过由于现在我只是做一个接口集成的项目,所以分布式就先不用了,用Spring AOP来达到切换数据源,查询不同的数据库就可以 ...
- 《CSS权威指南》基础复习+查漏补缺
前几天被朋友问到几个CSS问题,讲道理么,接触CSS是从大一开始的,也算有3年半了,总是觉得自己对css算是熟悉的了.然而还是被几个问题弄的"一脸懵逼"... 然后又是刚入职新公司 ...
- 一道关于阿里简单面试题的反思C/C++
题目是这样的: 正在挑战一个CrackMe的你,把需要填写的前面几位密码都正确猜出了,可是这最后一位密码,好像藏得有点深.CrackMe的作者还挑衅般的在里面藏了个.tar.gz文件,解压缩出来,里面 ...
- C#之数组篇
大杂烩 一.数组初始化 1.一维数组 String[] str = new String[3] { "1","2","3"}; ...
- JS复习--更新结束
js复习-01---03 一 JS简介 1,文档对象模型 2,浏览器对象模型 二 在HTML中使用JS 1,在html中使用<script></script>标签 2,引入外部 ...
- SQL case
case when Value='1' then 'True' else 'False' end as 'Result'
- Python调用服务接口
#! /usr/bin/env python # coding=utf-8 ############################################################## ...
- ETL简介
1.ETL的定义 ETL分别是“Extract”.“ Transform” .“Load”三个单词的首字母缩写也就是“抽取”.“转换”.“装载”,但我们日常往往简称其为数据抽取. ETL是BI/DW( ...
- 深入理解javascript原型和闭包（14）——从【自由变量】到【作用域链】
先解释一下什么是“自由变量”. 在A作用域中使用的变量x,却没有在A作用域中声明(即在其他作用域中声明的),对于A作用域来说,x就是一个自由变量.如下图 如上程序中,在调用fn()函数时,函数体中第6 ...