api doc的实体类结构

1,APIGroup

private int id;

private String name;

private Set<APIOne> aPIOnes;

 

2,APIOne

private int id;

/***

* 接口的访问地址,不包括ip

*/

private String url;

/***

* 请求方式:GET,POST,DELETE,PUT

*/

private String requestMethod;

/***

* 接口中文名称

*/

private String apiName;

/***

* 请求要素

*/

private Set<RequestQueryParameter> requestQueryParameters;

/***

* 应答要素

*/

private Set<ResponseElement> responseElements;

/***

* 请求的Content-Type

*/

private String requestContentType;

/***

* 应答头的Content-Type

*/

private String responseContentType;

private String requestExample;

private String responseExample;

/***

* 注意事项

*/

private String note;

/***

* 预留

*/

private String reserved;

private APIGroup aPIGroup;

 

3,RequestQueryParameter

private int id;

/***

* 字段名

*/

private String fieldName;

/***

* 类型

*/

private String fieldType;

/***

* 字段含义

*/

private String fieldMeaning;

/***

* 具体描述

*/

private String description;

/***

* 是否是必需:1必需,  2非必需

*/

private short necessary;

/***

* 预留

*/

private String reserved;

private APIOne aPIOne;

 

4,ResponseElement

private int id;

/***

* 字段名

*/

private String fieldName;

/***

* 类型

*/

private String fieldType;

/***

* 字段含义

*/

private String fieldMeaning;

/***

* 具体描述

*/

private String description;

 

/***

* 预留

*/

private String reserved;

private APIOne aPIOne;