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;

相关文章
|
3月前
|
消息中间件 存储 Java
RocketMQ-初体验RocketMQ(06)-使用API操作RocketMQ ,理解RocketMQ的存储结构
RocketMQ-初体验RocketMQ(06)-使用API操作RocketMQ ,理解RocketMQ的存储结构
175 0
|
10月前
|
存储 API C++
蓝桥杯考前突击(C++允许使用的api与存储结构)
蓝桥杯考前突击(C++允许使用的api与存储结构)
|
Kubernetes 前端开发 API
开发 k8s 管理平台 - k8sailor 06. 使用 api/biz/dao 分层结构管理数据请求,获取 deployment 数据
开发 k8s 管理平台 - k8sailor 06. 使用 api/biz/dao 分层结构管理数据请求,获取 deployment 数据
133 0
开发 k8s 管理平台 - k8sailor 06. 使用 api/biz/dao 分层结构管理数据请求,获取 deployment 数据
|
关系型数据库 API
【笔记】API参考—请求结构
本文主要介绍PolarDB-X 2.0支持的API请求结构,包括服务地址、请求协议和请求方法等。
|
关系型数据库 API
API参考—请求结构
本文主要介绍PolarDB-X 2.0支持的API请求结构,包括服务地址、请求协议和请求方法等。
|
Web App开发 NoSQL 数据库连接
grape动态PHP结构(三)——API接口
这里的v1、v2就是模块,由于客户端版本一直在迭代的,那么一些老版本的客户端调用的接口就得保留起来,使得兼容。新版本就直接调用新接口。
grape动态PHP结构(三)——API接口
|
关系型数据库 API
PolarDB-X 1.0-API参考-1.0(2019版本)-请求结构
本文主要介绍PolarDB-X 1.0 API的请求结构,包括服务地址、请求协议和请求方法等。
1873 0
PolarDB-X 1.0-API参考-1.0(2017版本)-OpenAPI使用-请求结构
OpenAPI 服务地址 PolarDB-X API 的服务接入地址为:drds.aliyuncs.com。
123 0
|
关系型数据库 API
API参考—请求结构
本文主要介绍PolarDB-X 2.0支持的API请求结构,包括服务地址、请求协议和请求方法等。
|
.NET API 开发框架
使用 dynamic 类型让 ASP.NET Core 实现 HATEOAS 结构的 RESTful API
上一篇写的是使用静态基类方法的实现步骤:  http://www.cnblogs.com/cgzl/p/8726805.html 使用dynamic (ExpandoObject)的好处就是可以动态组建返回类型, 之前使用的是ViewModel, 如果想返回结果的话, 肯定需要把ViewModel所有的属性都返回, 如果属性比较多, 就有可能造成性能和灵活性等问题.
1663 0