Dismiss
InnovationQ will be updated on Sunday, Oct. 22, from 10am ET - noon. You may experience brief service interruptions during that time.
Browse Prior Art Database

Restful API Framework - Non-User Parameters

IP.com Disclosure Number: IPCOM000244634D
Publication Date: 2015-Dec-31
Document File: 3 page(s) / 134K

Publishing Venue

The IP.com Prior Art Database

Abstract

Disclosed is an annotation framework and processor extension that adds a wealth of functionality to the Restful Application Programming Interface (API) framework; the particular focus is on non-user parameters.

This text was extracted from a PDF file.
This is the abbreviated version, containing approximately 59% of the total text.

Page 01 of 3

Restful API Framework - Non-User Parameters

The majority of Restful Application Programming Interface (API) frameworks implement as web services using annotations. This is an effective means of mapping Restful API endpoints to Java * methods. However, existing annotation frameworks lack many desirable capabilities such as versioning, Javadoc documentation, non-user parameters, and more.

The novel contribution is an annotation framework and processor extension that adds a wealth of functionality to the Restful API framework; the particular focus is on non-user parameters.

Most existing frameworks bypass a requirement for non-user parameters by using instance members or static objects; however, this is not a suitable solution, as it does not allow the developer to configure an object based on the user's request or other dynamic information.

This proposed solution extends an existing Restful API annotation framework with a new annotation , @APICustomParameter . This annotation is assigned to individual method parameters that are already properly annotated with other Java annotations ,

which allow it to become a webservice.

This annotation has a primary, required attribute: source . The source is the Java class that extends a common interface, ICustomParameter ; this class is used to actually provide the object. In the event that the user wants to configure a class without creating a new implementation, the user can provide additional properties using the properties...