KR101331854B1

KR101331854B1 - Apparatus and method for search Open API and generation mashup block skeleton code

Info

Publication number: KR101331854B1
Application number: KR1020100040122A
Authority: KR
Inventors: 장윤섭; 이성호; 김재철; 유재준; 박선례; 윤창락; 김학철; 이기정; 김경옥; 박종현
Original assignee: 한국전자통신연구원
Priority date: 2009-12-18
Filing date: 2010-04-29
Publication date: 2013-11-21
Also published as: KR20110070724A

Abstract

Open API integrated search and mashup block-based code generation method of the present invention, Open API integrated search and mashup block-based code generation device, comprising: storing the metadata of the web service and the open API to maintain the integrated schema; Searching for a web service or an open API corresponding to a search query received from a user; Extracting metadata necessary for generating a base code of metadata of the mashup block by using a mapping relationship between metadata of the found web service or open API and metadata of the mashup block; And generating a base code of metadata of the mashup block using the extracted metadata.

Description

Apparatus and method for search Open API and generation mashup block skeleton code}

The present invention relates to an open API integrated search and mashup block based code generation device and method thereof. More specifically, the unified schema enables the integrated search of web services and open APIs in one search system, and the similarity between the unified schema for web services and open APIs and the metadata schema of the mashup block. A method and apparatus for enabling generation of base code of metadata of a mashup block are provided.

The present invention is derived from a study performed as part of a high-tech urban development project of the Ministry of Land, Transport and Maritime Affairs [Task management number: 07 national land information C05, task name: u-GIS core convergence, complex technology development].

With the expansion of services on the Internet, there is an increasing need to manage Web services. Web services are software services. That is, the service provided by the software module may include, for example, a translation service for translating an English text file into a Chinese text file.

The most popular Web services management methods are the UDDI-based registry (Universal Description, Discovery and Integration based registry). UDDI is a standard for publishing and retrieving information about web services. This standard uses an information framework for descriptions and classifications of information, such as web services, and uses interfaces for web services.

However, UDDI based web services have some problems.

First, the UDDI-based approach requires the use of a UDDI-based database. This increased cost has forced many small service providers to be reluctant to use UDDI-based registries.

Furthermore, UDDI-based web services are not detected by general purpose search engines (eg Google). This is because in order to publish a service, service providers must register the service in a UDDI-based registry, and to retrieve such a service, the user must search the registry's UDDI database itself. Although a web-based interface is provided for these searches, general-purpose search engines cannot directly access or search these UDDI databases.

Furthermore, UDDI uses the Web Services Description Language (WSDL) to describe the interface to Web services, which makes it more difficult for users to find and select services. This is because when a user needs to use a service, he or she typically tries to find the service by describing the purpose and / or function of the service.

However, service disclosure using WDSL generally only defines service invocation interfaces and does not describe the purpose or function of the service, making the user difficult to use.

In addition, when selecting services using UDDI, users often have to consider other factors such as cost, reliability, customer support, performance, and resource consumption. Although UDDI-based web service registries contain some of that information, it is not easy to access them, further interfering with the use and acceptance of these services. Moreover, UDDI-based registries only provide service providers with mechanisms for publishing and uploading services, but do not provide a means for users to feedback, rate, and rate services.

As a result, conventional services often disappoint users and require considerable time and effort to select a useful service from a UDDI database.

In recent years, attempts have been made using RSS (Really Simple Syndicate, used for content distribution) to enable search of WSDL-based web services by general-purpose search engines. In these attempts, the URL of the service WSDL file is embedded as an item in the RSS feed, which can be detected by general search engines. However, such RSS based web service retrieval requires the user to have an RSS reader and aggregator on the access device and to subscribe to the RSS feed. This means that if a change occurs in the feed, the change is fed to the user device. Although users can feedback on services provided by RSS-based web service searches, this approach does not allow for easy configuration of feedback, and provides easy access to select the desired service. It is not easy to associate the corresponding service with the user's feedback to do so. In addition, under these mechanisms, the user cannot describe the purpose and function of the service.

Therefore, there is a need for the development of a method and system for searchable web services to solve the above problems.

In particular, as in the present invention, the integrated search technology using the same description format for the web service and the Open API (Open Application Programming Interface) is insufficient. The development of mashup using the web service and the open API has various techniques in the related art, but the base code generation technology as in the present invention, which enables the search results of the web service and the open API to be immediately used in the mashup, is also insufficient.

The present invention has been proposed to solve the above problems,

An object of the present invention is to provide a search method and apparatus that can search a web service and an open API in a single search system using an integrated schema.

Another object of the present invention is to provide a block-based code generation method and apparatus for automatically generating a base code using a similarity between an integrated schema for a web service and an open API and a metadata schema of a mashup block.

It is still another object of the present invention to provide a block-based code generation method and apparatus for directly utilizing a result of integrated search for a web service and an open API using WSDL in mashup development.

In particular, the method may further include generating a base code of the source code of the mashup block using the base code of the generated metadata.

In addition, the unified schema is a schema in which a new schema element in which description content of open APIs not included in the description language of the web service is recorded is added or an existing schema element is modified. It is done.

The mashup block may be stored and managed as source code including metadata describing at least one of a service, an operation, an input, an output, an attribute, and an event that can be provided, and program logic that is called and executed. do.

The searching of the web service or the open API corresponding to the search query input from the user may include searching a specific range, weighted search, and transfer using metadata of the stored web service and the open API according to the integrated schema. And performing one or more searches of a combinationable service search, a next combinationable service search, and a cross combinationable service search.

On the other hand, the open API integrated search and mashup block-based code generation device of the present invention, the service storage unit for storing the metadata of the web service and the open API written in accordance with the integrated schema; Search the web service or open API corresponding to the search query input from the user, and generate the base code of the metadata of the mashup block by using the mapping relationship between the metadata of the searched web service or the open API and the metadata of the mashup block. A search processor for extracting necessary metadata; And a base code generation unit configured to generate a base code of metadata of the mashup block using the extracted metadata.

In particular, the base code generator, characterized in that for generating the base code of the source code of the mashup block using the base code of the generated metadata.

In addition, the search processing unit, by using the metadata of the web service and the open API stored in accordance with the integrated schema, a specific range search, weighted search, previous combination possible service search, next combination possible service search, cross combination possible service search To perform one or more of the searches.

The mashup manager may store and manage the mashup block as source code including metadata describing at least one of a service, an operation, an input, an output, an attribute, and an event, and a program logic that is called and executed. It is characterized by further comprising.

According to the present invention, the following effects can be expected.

It allows you to integrate web services and multiple types of open APIs together in one search system, allowing you to expand your mashup resources (web services and open APIs). It can be increased.

In addition, by automatically generating the base code of the mashup block from the web service and open API search results, the web service and open API search results can be directly used for mashup development, which greatly reduces the time and cost of mashup development. It can be effected.

1 is a diagram illustrating an example of a mashup service based on a conventional open API.
FIG. 2 is a diagram for explaining an existing method for authoring a mashup of the form shown in FIG. 1.
3 is a view for explaining the configuration of the open API integrated search and mashup block based code generation apparatus according to the present invention.
4 illustrates an example of description content of an irregular web page (HTML) format.
5 is a diagram illustrating an example of a unified schema newly defined in the present invention.
6 is a diagram illustrating an example of a weighted search.
7 is a diagram illustrating an example of a previous searchable service combination.
8 is a diagram illustrating an example of a searchable combination service later.
9 is a diagram illustrating an example of cross-combinable service search.
10 is a diagram illustrating an example of metadata about a mashup block.
11 is a diagram illustrating an example of source code of a mashup block.
12 is a diagram illustrating an example of authoring a mashup project using a mashup block.
13 is a flowchart illustrating a method of generating an integrated API and searching a mashup block based code according to the present invention.

The present invention will now be described in detail with reference to the accompanying drawings. Hereinafter, a repeated description, a known function that may obscure the gist of the present invention, and a detailed description of the configuration will be omitted. Embodiments of the present invention are provided to more fully describe the present invention to those skilled in the art. Accordingly, the shapes and sizes of the elements in the drawings and the like can be exaggerated for clarity.

First, mashup means fusion of information and services provided through the web to create new software, services, databases, etc., and is attracting attention as a component of Web 2.0.

A number of mashups have emerged around the United States, ranging from practical ones such as crime statistics, hurricane information, and gas station prices, to hobby and entertainment, such as hot spring information, UFO sightings, and site information at specific locations. There is. It is also accelerating the development of APIs that are the source of mashups.

For example, Google's Housing Maps, a service that combines real estate listings with Google Maps. The advantage of these services is that they cost little to build data or develop. There are a growing number of cases where APIs are disclosed as web services, such as map services provided by Google, Yahoo, Microsoft, and product information provided by the Internet bookstore Amazon. New services are provided by fusing contents and the like.

Mashup services are technologies that combine two or more APIs into a new API on the web. The advantage of mashup services is that by utilizing existing open APIs, you can reduce the effort to implement new services and maximize the utilization of existing open APIs.

1 is a diagram illustrating an example of a mashup service based on a conventional open API.

Referring to FIG. 1, a mashup 110 in which a photo service of Flickr is combined with a map service of Google is illustrated.

In this case, the mashup 110 is configured such that when a user clicks a specific location on the map with a mouse, the pictures of the related location are displayed on the map. The HTML code 120 of this mashup 110 is shown on the right side of FIG. 1.

FIG. 2 is a diagram for explaining an existing method for authoring a mashup of the form shown in FIG. 1.

Referring to FIG. 2, a mashup developer first plans what type of mashup to produce (202), and then retrieves and selects open APIs 210 and 216 to be used to produce the planned mashup (204).

If the mashup developer decides to create a mashup service using the Google Map Open API and the Flickr Open API, the mashup developer analyzes the Google Map Open API and the Flickr Open API to determine the characteristics of each open API service (eg, communication). Protocol, data format, format of input / output data, etc.) (206). The open API service provider generates user account information 212 and 218 or user authentication key 214 and provides it to the developer.

The mashup developer completes the final mashup content by securing the open API, implementing the mashup function by referring to the manual provided by the open API service provider, and determining the layout of the HTML page (208).

Therefore, there is a problem that the mashup developer should be in charge of all parts related to the mashup implementation such as communication protocol and data format conversion 220.

In particular, since the method of providing an open API service is different for each open API service provider, a developer must first acquire an analysis and related technology for various open API services, and there is a problem that a mashup depends on the developer's ability.

In addition, since the code or script of the open API constituting the mashup is arbitrarily produced by the developer, there is a problem that it is difficult to update the open API constituting the mashup or add a new open API to the existing mashup.

The present invention is to solve the above-mentioned problems, and to utilize the search results of the web service and open API integration search results in the mashup development, the base code (skeleton) by using the similarity between the schema for the web service and open API and the mashup block schema Provides a way to generate code automatically.

Hereinafter, an open API integrated search and mashup block based code generation method and apparatus according to the present invention will be described in detail with reference to the accompanying drawings.

First, the present invention changes the WSDL, which is a description format of an existing SOAP type web service, into a new integration schema. Description of an indeterminate web page (HTML) format as shown in FIG. 4 for various types of open APIs such as REST, Javascript, RSS / ATOM, etc., which are simultaneously served by multiple sites (eg, Google, Yahoo, etc.). To define a unified schema for multiple formats, open APIs for multiple sites. Here, the process of changing the WSDL, which is a web service description format, to a new unified schema, adds a new schema element that records descriptions of various types of open APIs that are not included in the web services WSDL, or adds an existing schema element. It involves the process of correction.

That is, the present invention defines a schema of a web service and an open API as one unified schema, thereby providing a method for searching both a web service and an open API in one search system. 5 is a diagram illustrating an example of an integration schema newly defined by the present invention. The present invention has been devised based on the fact that the schema of a web service and the schema of an open API are largely similar in format for defining providers, service classifications, individual services, operations, inputs, and outputs.

3 is a view for explaining the configuration of the open API integrated search and mashup block based code generation apparatus according to the present invention.

Referring to FIG. 3, the open API integrated search and mashup block based code generation apparatus 300 according to the present invention includes a service storage unit 330, a search processing unit 340, a base code generation unit 350, and a mashup block management unit. 320 is provided.

The service storage unit 330 stores and manages metadata of a web service and an open API created by following an integrated schema. Here, integration schemas for web services and open APIs can be defined based on similarities, such as the format for defining providers, service classifications, individual services, operations, inputs, and outputs. For example, as shown in FIG. 5, the unified schema defined in this way is substantially similar to the schema of metadata of the mashup block that is the target of the mashup. The metadata of the web service and the open API stored in the service storage unit 330 is then used when searching for the web service or the open API.

The mashup block manager 320 stores and manages the mashup blocks in which the base code is generated through the base code generator 350. In this case, in managing the mashup block, the mashup manager 320 includes metadata describing services, operations, inputs, outputs, attributes, and events that the mashup block can provide, and program logic that is called and executed. Store and manage as source code. 10 and 11 illustrate examples of metadata and source code of a mashup block, respectively.

The search processor 340 searches for a web service or an open API corresponding to a search query input from a user, and uses a mapping relationship between metadata of the searched web service or the open API and metadata of a mashup block to be mashed up. The information (metadata) necessary for generating the base code of the metadata of the mashup block is extracted from the service storage unit 330.

Since the search processing unit 340 performs a search using the newly defined integration schema, it is possible to search for sub-steps such as individual services, operations, inputs and outputs of the web service and the open API.

Therefore, the search processing unit 340 of the present invention can search for a specific range, weighted search (see FIG. 6), previous combinationable service search (see FIG. 7), next combinationable service search (FIG. 8), and cross combination. It is possible to perform a service search (see FIG. 9) and the like.

On the other hand, the base code generation unit 350 generates the base code of the metadata of the mashup block to be mashup using the information extracted by the search processing unit 340. Then, the base code generation unit 350 generates the base code of the source code of the mashup block by using the base code of the generated metadata.

According to the device of the present invention as described above, by allowing a single search system to search the web services and open APIs of various formats together, it is possible to expand the mashup resources, thereby expanding the scope of mashup development And usability can be increased. In addition, by automatically generating the base code of the mashup block from the web service and open API search results, the web service and open API search results can be directly used for mashup development, which greatly reduces the time and cost of mashup development. You can do it.

13 is a flowchart illustrating a method of generating an integrated API and searching a mashup block based code according to the present invention.

Referring to FIG. 13, first, metadata of a WSDL, which is a description format of an existing SOAP format web service, is stored under an integrated schema (S300). At the same time, a malformed web page (HTML) format description, such as FIG. 4, for various types of open APIs such as REST, Javascript, RSS / ATOM, etc., served on multiple sites (eg, Google, Yahoo, etc.). From the contents, metadata of various types and open APIs of various sites are kept in accordance with the integrated schema (S310). As described above, the unified schema at this time may be a schema in which new schema elements in which descriptions of open APIs which are not included in the description language of the web service are added or existing schema elements are modified are added. it means.

Through the steps S300 and S310, metadata of the web service and the open API, which is created while keeping the integrated schema, is stored, and when a search query is input from the user (S330), the web service or the open API corresponding to the search query received from the user Search for and extract information (metadata) necessary for generating the base code of the metadata of the mashup block using the mapping relationship between the metadata of the found web service or the open API and the metadata of the mashup block (S340). S350).

When the metadata is extracted through the step S350, the search processor delivers the extracted information to the base code generator, and the base code generator generates the base code of the metadata of the corresponding mashup block using the extracted information (S360). .

Further, the base code generation unit generates the base code of the source code of the mashup block by using the base code of the metadata generated through the step S310 (S370).

12 is a diagram illustrating an embodiment of authoring a mashup project using a mashup block generated through the above-described process.

According to the present invention, it is possible not only to develop a new mashup service through additional block authoring and mashup project authoring on the base content, but also to collectively search a web service and various types of open APIs in one search system.

As described above, an optimal embodiment has been disclosed in the drawings and specification. Although specific terms have been employed herein, they are used for purposes of illustration only and are not intended to limit the scope of the invention as defined in the claims or the claims. Therefore, those skilled in the art will appreciate that various modifications and equivalent embodiments are possible without departing from the scope of the present invention. Accordingly, the true scope of the present invention should be determined by the technical idea of the appended claims.

1: UDDI 2: WSDL
10: Web Service 2: Open API
320: mashup block management unit 330: service storage unit
340: search processing unit 350: base code generation unit

Claims

Open API integrated search and mashup block based code generation device,
Storing metadata of web services and open APIs under an integrated schema;
Searching for a web service or an open API corresponding to a search query received from a user;
Extracting metadata necessary for generating a base code of metadata of the mashup block by using a mapping relationship between metadata of the found web service or open API and metadata of the mashup block; And
And generating a base code of metadata of the mashup block using the extracted metadata.

The method according to claim 1,
And generating a base code of the source code of the mashup block by using the base code of the generated metadata.

The method according to claim 1,
The integration schema,
Open API integration search, characterized in that a new schema element is recorded that the description of the open APIs that are not included in the description language of the web service is added, or that the existing schema elements are modified. And mashup block based code generation method.

The method according to claim 1,
The mashup block,
Open API integration retrieval, characterized in that it is stored and managed as source code, including metadata describing one or more of the services, operations, inputs, outputs, attributes, and events that can be provided, and program logic that is called and executed; How to generate mashup block based code.

The method according to claim 1,
Searching for a web service or an open API corresponding to the search query received from the user,
Performing one or more of a specific range search, weighted search, previous combinable service search, next combinable service search, and cross-combinable service search using metadata of the web service and the open API stored according to the integrated schema. Open API integrated search and mashup block based code generation method comprising the step.

delete