`

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;

分享到:
评论

相关推荐

    Maven插件源码:根据库表生成实体类&根据实体类生成库表

    这个Maven插件解决了这个问题,它能自动扫描数据库中的表结构,包括字段名、字段类型、字段长度、是否可为空等信息,然后自动生成对应的Java实体类。这些实体类不仅包含了字段,还带有对应的getter和setter方法,...

    GWT 2.3.0 API DOC chm 版

    开发者可以通过定义服务接口和实体类来实现远程数据访问。 3. **History and URLs**: GWT提供了对浏览器历史记录(History)和URL管理的支持,使得单页应用可以实现类似多页面应用的导航体验。`...

    实体类自动生产

    实体类自动生产是一种提高开发效率的技术,它允许开发者通过工具自动生成与数据库表结构对应的实体类,避免手动编写繁琐的getter、setter方法和构造函数。 在给定的描述中提到了一个链接,虽然无法直接访问,但通常...

    JavaEE_6_API帮助文档.zip

    JavaEE 6 API帮助文档详细阐述了这些技术和API的用法,包括类、接口、方法、属性以及示例代码,是开发者深入理解JavaEE 6开发的重要参考资料。通过阅读和实践,开发者可以更好地掌握JavaEE 6平台的各种功能,提升...

    dom4j_API_示例.doc

    - **Entity**: 定义XML实体,支持外部实体的引用和解析。 - **Node**: 为所有DOM4J中的XML节点定义了通用行为,是DOM4J中最基础的接口之一。 - **NodeFilter**: 定义了节点过滤行为,可用于筛选特定类型的节点,提高...

    JAVA_API1.6文档(中文)

    javax.xml.crypto.dsig.keyinfo 用来解析和处理 KeyInfo 元素和结构的类。 javax.xml.crypto.dsig.spec XML 数字签名的参数类。 javax.xml.datatype XML/Java 类型映射关系。 javax.xml.namespace XML 名称空间...

    111、使用ApiResource注解创建文章API1

    当API Platform扫描完实体类后,它会自动生成一系列预定义的API接口,包括但不限于以下几种类型: - **GET /posts**:获取所有文章资源的集合。 - **POST /posts**:创建一个新的文章资源。 - **GET /posts/{id}**...

    系统结构复习题型.doc

    文档“系统结构复习题型.doc”提供了计算机系统结构的相关复习题目,主要涵盖了多个知识点,包括并行处理、流水线技术、虚拟存储器管理、性能优化、存储系统层次结构以及指令编码设计。以下是对这些知识点的详细说明...

    Java 1.6 API 中文 New

    javax.xml.crypto.dsig.keyinfo 用来解析和处理 KeyInfo 元素和结构的类。 javax.xml.crypto.dsig.spec XML 数字签名的参数类。 javax.xml.datatype XML/Java 类型映射关系。 javax.xml.namespace XML 名称空间处理...

    EF教程.doc

    - **具体操作**:在DbContext派生类中使用Fluent API来定义实体类与数据库表之间的映射规则。 通过以上各个步骤的学习和实践,开发者能够全面掌握Entity Framework的基本使用方法和技术细节,从而有效地利用这一...

    JPA实体bean配置,jpa增删改api,jpasql增删改.doc

    持久化文件定义了数据源的信息以及如何处理实体类。 ```xml xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/persistence ...

    将C# 类文件中属性和方法自动生成文档,C#类文档结构化生成

    类文档不仅方便开发者理解和使用API,还可以减少代码注释的工作量。本话题将深入探讨如何自动生成C#类中的属性和方法的文档,以及涉及到的相关工具和技术。 一、XML注释与文档生成 C#支持XML注释,它允许程序员在...

    java api最新7.0

    javax.xml.crypto.dsig.keyinfo 用来解析和处理 KeyInfo 元素和结构的类。 javax.xml.crypto.dsig.spec XML 数字签名的参数类。 javax.xml.datatype XML/Java 类型映射关系。 javax.xml.namespace XML 名称空间处理...

    创建ASP-NET-Web-API-2.0应用实例.doc

    2. **定义数据模型**:在`Common`项目中,定义表示业务实体的数据类型,如`Contact`类,包含ID、姓名、电话、电子邮件和地址等属性。 ```csharp public class Contact { public string Id { get; set; } public ...

    API文档合集

    2. **Spring Framework 3.0.5 API DOC.chm**:Spring是一个流行的Java企业级应用框架,这个文档详细介绍了其3.0.5版本的API。包括依赖注入、AOP(面向切面编程)、事务管理、MVC(模型-视图-控制器)组件等,对于...

    nopCommerce的源代码结构和架构说明.doc

    - `Nop.Core`:包含了nopCommerce的核心类,如缓存管理、事件系统、辅助工具和业务对象(如订单、客户等实体类)。这些类定义了系统的基础结构和基本行为。 - `Nop.Data`:这个项目负责数据访问,使用Entity ...

    swagger api开发使用说明书1

    `@ApiModel` 描述整个实体模型,而 `@ApiModelProperty` 用于描述实体类的各个属性。 ### 使用说明 1. **启动项目** - 首先,确保你的项目已经成功启动并监听在 `http://localhost:8080` 上。 2. **登录** - 访问...

    Parasolid functional description Doc

    Parasolid内核的核心是其类结构,类结构中定义了各种基本几何形状和操作方法。其中,实体类是构成模型的基本单位,每个实体类都有与之相关的标识符和属性。在代码中使用实体类时,可以借助标识符来引用特定的实体。...

Global site tag (gtag.js) - Google Analytics