关于WebApi的定义讨论

对于很多公司，规范的webapi是多系统交互和生态系统建设的重要部分。

讨论之前推荐一个网站，Mock API用这个做比较规范和准确。

Apifox - API 文档、调试、Mock、测试一体化协作平台。拥有接口文档管理、接口调试、Mock、自动化测试等功能，接口开发、测试、联调效率，提升 10 倍。最好用的接口文档管理工具，接口自动化测试工具。

那么我们看下常用的格式，至少包括如下内容，完备的需要加上返回值，返回消息和data字段。

1. 批次查询

接口说明	查询系统中所有的批次
请求URL	/app/batch/list
请求方法	GET	请求数据格式	JSON
请求参数
字段名	类型	是否必须[M/O]	描述
IsCurrent	Bool	O	True or false 是否只返回当前开放申请批次
响应参数（JSON）
字段名	类型	是否必须[M/O]	描述
BatchId	String	M	批次ID
BatchName	String	M	批次名称
IsCurrent	Bool	M	是否当前开放批次（开放批次可填报）
StartTime	DateTime	M	批次开始时间
EndTime	DateTime	M	批次结束时间
描述	查询系统内容的批次信息，及当前可填报批次信息