JP5209016B2 - WebAPI creation support apparatus and WebAPI creation support method - Google Patents

Description

  The present invention provides a user (third party) of a WebAPI library that develops a Web application using a Web application function (hereinafter referred to as “WebAPI function”) included in the Web application library (hereinafter referred to as “WebAPI library”). The present invention relates to a WebAPI creation support apparatus and a WebAPI creation support method that support both the developer and the developer.

  Conventionally, application development support is provided by providing an application developer with an API library in which a plurality of highly versatile API functions are combined into one file. For example, Patent Document 1 discloses a simulator with a debugging function, a cross compiler for generating an execution code or an interpreter for executing a source code at a time, source code storage means for storing a source code created by a user, software An application development environment system that provides a user with a software development environment comprising software library storage means for storing a library group is disclosed.

  An application developer can easily develop an application by creating a program using an API function included in the provided API library.

JP 2002-182910 A

  By the way, when developing an application, a user of an API function library desires to check how an API function included in the provided API function library operates. In particular, when the API function library is updated, the user needs to check what kind of change occurs in the operation of the API function due to the update.

  Until now, in order for a user of an API function to check the operation of the API function, it is common for the developer to directly access the Web server storing the API function library and check the operation of the API function. there were. However, such a confirmation method requires a lot of time and effort from the time when the user knows the existence of the API function until the test of the operation confirmation, and it is not always excellent from the viewpoint of convenience. I could not say.

  For example, when a Web API function is newly provided, when the user of the Web API function confirms the operation of the Web API function, the URL indicating the location of the entity of the Web API function by referring to a document or the like It is necessary to confirm the parameter definition, confirm the calling procedure, and describe the calling protocol by itself. Furthermore, even when a developer who develops a Web API function debugs the Web API function, the operation confirmation test cannot be immediately started, and the same problem occurs. And the technique of patent document 1 cannot solve such a problem.

  Accordingly, an object of the present invention is to provide a Web API creation support apparatus and a Web API creation support method that can improve the convenience of checking the operation of a Web API function included in the Web API library for both users and developers of the Web API library. And

  (1) A definition information file of a WebAPI library, including a parameter description section describing each parameter of a plurality of WebAPI functions included in the WebAPI library, and an option description section describing a check specification condition of input information for the parameter Update confirmation means for confirming the update of the definition information file included, file read means for reading the definition information file in response to the update of the definition information file, and the parameter from the parameter description part of the read definition information file And an input box generation means for generating HTML code for displaying the number of the extracted input boxes for the parameters, and the check specification condition of the option description part of the read definition information file Check function generation means for generating a check function for checking parameters of input information input to the input box, a test execution function of the WebAPI function based on the input information input to the input box, and based on the check function A Web API creation support apparatus comprising: an input form generation unit that generates an HTML code for displaying a Web page input form having a function of checking a parameter of input information input to the input box.

According to the Web API creation support apparatus of (1), the input box generation unit generates an HTML code that displays the number of input boxes corresponding to the parameters of the Web API function from the parameter description part of the definition information file, and the input form generation unit. Generates an HTML code for displaying a Web page input form having a Web API function test execution function based on the input information input in the input box.
As a result, the application developer is provided with a Web page input form in which the execution result (operation) of the WebAPI function included in the WebAPI library can be confirmed, and the convenience of confirming the operation of the WebAPI function is improved. Can do.
This Web page input form also includes a parameter check function by a check function that performs parameter check of input information input to the input box generated by the check function generation unit. Validation processing can also be performed, and the convenience of checking the operation of the API function can be further improved.

  (2) Described in (1), comprising parameter specifying means for interpreting a specification of an output format of the WebAPI function from a parameter description part of the definition information file and generating an HTML code for displaying an input box reflecting the specification. WebAPI creation support device.

  According to the WebAPI creation support apparatus of (2), an appropriate output format can be automatically specified.

  (3) The Web API creation support apparatus according to (1) or (2), wherein the input form generation unit generates an HTML code for displaying the Web page input form in a Web page format that can be browsed via a network.

  According to the Web API creation support apparatus of (3), since the web page input form is generated in the form of the web page, the application developer can easily access the web page input form and check the operation of the web API function. Convenience can be further improved.

  (4) A definition information file of a WebAPI library executed by a predetermined computer, a parameter description part describing each parameter of a plurality of WebAPI functions included in the WebAPI library, and a condition for specifying input information for the parameter A step of confirming an update of a definition information file including an option description section describing the information, a step of reading the definition information file in response to the update of the definition information file, and a parameter description section of the read definition information file The parameter is extracted from, the input box for the parameter is extracted and the HTML code for displaying the number of the parameters is generated, and the check specification condition of the option description part of the read definition information file is interpreted A step of generating a check function for performing a parameter check of the input information input to the input box, a test execution function of the WebAPI function based on the input information input to the input box, and the input based on the check function Generating an HTML code for displaying a Web page input form having a function of checking a parameter of input information input to a box.

  According to the WebAPI creation support method of (4), the same effects as the WebAPI creation support device of (1) are produced.

  According to the present invention, it is possible for both users and developers of a Web API library to improve the convenience of confirming the operation of the Web API function included in the Web API library.

It is a figure which shows the function structure of the API creation assistance apparatus of this invention. It is a figure which shows a definition information file. It is a figure which shows the source code of a web page input form. It is a figure which shows the example of a display of a web page input form. It is a figure which shows the example of a display of the execution result of the API function based on the input of a web page input form. It is a flowchart which shows the flow of a process of API creation assistance apparatus.

  Embodiments of the present invention will be described below with reference to the drawings.

[Configuration of WebWeb API Creation Support Device 1]
With reference to FIG. 1, the WebWeb API creation support apparatus 1 of this embodiment is demonstrated. FIG. 1 is a block diagram showing a functional configuration of the Web API creation support apparatus 1. The WebAPI creation support apparatus 1 is connected to the library developer terminal 2, the WebAPI library server 3, and the library user terminal 4 so that they can communicate with each other.
The library developer terminal 2 is a terminal used by the developer of the WebAPI library, and the WebAPI library server 3 is a server that stores the WebAPI library created by the library developer terminal 2, and the library user terminal 4 Is a terminal used by an application developer who develops an application using the WebAPI library stored in the WebAPI library server 3. When the developer of the Web API library develops the Web API library, the developer of the Web API library stores the Web API library in the Web API library server 3. The application developer accesses the WebAPI library server 3 and develops an application using the stored WebAPI library.

  The Web API creation support apparatus 1 according to this embodiment includes a storage unit 11, an update confirmation unit 12, a file reading unit 13, an input form generation unit 14, a parameter check execution unit 15, a function execution unit 16, and an execution result. And output means 17.

  In the storage unit 11, a definition information file 110 corresponding to the WebAPI library stored in the WebAPI library server 3 is stored for each WebAPI library. Here, the definition information file 110 is created by the developer of the Web API library and stored in the storage unit 11. That is, when the developer of the Web API library develops the Web API library, it also creates the definition information file 110 of the Web API library. The developer of the WebAPI library stores the WebAPI library in the WebAPI library server 3 and stores the definition information file 110 in the storage unit 11 of the WebAPI creation support apparatus 1 of the present invention. Further, when the WebAPI library developer updates the WebAPI library, the developer accesses the storage unit 11 and updates the definition information file 110 corresponding to the WebAPI library.

  The definition information file 110 created / updated by the developer of the WebAPI library will be described with reference to FIG. The definition information file 110 is created as an example ini file, and includes a server description unit 111, a Web API function description unit 112, a parameter description unit 113, and an option description unit 114.

  The server description unit 111 describes server definition information such as the address of the WebAPI library server 3 that stores the corresponding WebAPI library. In the Web API function description section 112, Web API function definition information such as the type and address of the Web API function included in the corresponding Web API library is described. The parameter description section 113 describes parameter definition information related to the parameters of the Web API function. In the option description section 114, a check specification condition of input information for a parameter of the WebAPI function is described.

  FIG. 2 shows a definition information file 110 relating to the WebAPI library stored in the WebAPI library server 3 called “workflow” (server description unit 111). Further, a plurality of WebAPI functions of this WebAPI library include a WebAPI function “getAPIpIdList” (WebAPI function description unit 112), and this WebAPI function has parameters “query”, “start”, “results”, and “output”. (Parameter description part 113), it is specified that only the character string of “0” to “9” can be input in the range of “999” to “−999” (option description part 114) for the “start” parameter. ing.

  Returning to FIG. 1, the update confirmation unit 12 confirms whether or not the definition information file 110 stored in the storage unit 11 has been updated. Whether or not the definition information file 110 is updated can be determined by an arbitrary method. For example, it may be confirmed whether the definition information file 110 has been updated based on the update date of the file. In addition to being updated, the definition information file 110 that existed was rewritten by the developer of the WebAPI library, and the definition information file 110 that did not exist was newly created by the developer of the WebAPI library. Including that.

  The file reading unit 13 reads the updated definition information file 110 from the storage unit 11 on the condition that the update confirmation unit 12 confirms that the definition information file 110 has been updated.

The input form generation unit 14 generates an HTML code for displaying the web page input form 100 from the read definition information file 110. Here, the HTML code for displaying the Web page input form 100 generated by the input form generation unit 14 is generated for each Web API library, and is used for confirming the operation of the Web API function included in the Web API library. The operation check of the WebAPI function includes a validation process (parameter check function) of the specified parameter in addition to the operation check (test execution function) of the WebAPI function when the parameter is specified.
An example of HTML code for displaying the Web page input form 100 generated by the input form generation unit 14 is shown in FIG. FIG. 4 shows a Web page input form 100 that is a part for confirming the operation of the Web API function “getAPIpIdList”. As shown in FIG. 4, the Web page input form 100 of this embodiment includes at least an input box 102A for receiving input information for parameters of the Web API function and a button 104A for prompting a predetermined operation.

  By inputting predetermined information into the Web page input form 100, the application developer can easily confirm the operation of the Web API function included in the Web API library. In particular, in this embodiment, the web page input form 100 is generated in the form of a web page (HTML) and published on the network, so even a remote application developer can easily access the web page input form 100. The convenience of checking the operation of the Web API function can be further improved. In addition, since the input form generation unit 14 generates an HTML code that displays the Web page input form 100 every time the definition information file 110 is updated, the application developer can check the operation of the latest Web API function. .

  Returning to FIG. 1, the input form generation unit 14 generates an HTML code for displaying the Web page input form 100, so that the Web API function specification unit 141, the input box generation unit 142, the parameter specification unit 143, and the check function generation And means 144.

  The Web API function specifying unit 141 specifies the address of the Web API function from the server description part 111 and the Web API function description part 112 of the definition information file 110. The input box generation unit 142 extracts the parameter of the Web API function from the parameter description unit 113 of the definition information file 110, and generates an HTML code that displays the input box 102A for the parameter. When the value to be input to the parameter of the Web API function is defined, the parameter specifying unit 143 automatically inputs the value to the input box 102A. For example, when the output format is described in the parameter description section 113 of the definition information file 110, the parameter specification unit 143 outputs the output format to the input box 102A so that the execution result of the Web API function is output according to the output format. Enter. In addition, the check function generation unit 144 extracts the input information check designation condition for the parameter from the option description unit 114 of the definition information file 110, and generates an input condition for the parameter.

  With reference to FIG. 3, the generation of the HTML code for displaying the Web page input form 100 by the input form generation means 14 will be specifically described.

  The Web API function specifying unit 141 of the input form generating unit 14 generates the Web API function description code 101 from the server description unit 111 and the Web API function description unit 112 of the definition information file 110. The Web API function description code 101 describes the name and address of the Web API function.

  The input box generation unit 142 of the input form generation unit 14 generates the input box generation code 102 for forming the input box 102A for the parameters described in the parameter description unit 113 of the definition information file 110. The generated input box generation code 102 forms an input box 102A shown in FIG.

The parameter specifying unit 143 of the input form generating unit 14 describes the value to be input to the parameter of the Web API function in the input box generation code 102 when the parameter description unit 113 of the definition information file 110 defines the value to be input to the parameter of the Web API function. In FIG. 3, the parameter description section 113 of the definition information file 110 defines “xml” for the parameter “output”. As a result, the parameter specifying unit 143 automatically inputs “xml” to “value” of “output” of the input box generation code 102.
As described above, in this embodiment, when the output format of the execution result of the Web API function is predetermined, the HTML code for displaying the Web page input form is generated so as to output the execution result according to the format. . As a result, the execution result can be output in an appropriate output format, and convenience can be improved. The parameter for which the value to be input is defined is not limited to “output”, and the parameter specifying unit 143 automatically inputs the value for the parameter for which the value to be input is defined.

The check function generation unit 144 of the input form generation unit 14 generates the input condition description code 103 (check function) when the condition of the value input to the parameter is defined in the option description unit 114 of the definition information file 110. . The input condition description code 103 is a code for determining whether or not a value input to a parameter has a predetermined condition, and is described in javascript (registered trademark) as an example. For example, the check function generation unit 144 generates a check function for designating a numerical range or a character string of values to be input as parameters. Referring to FIG. 3, the option description section 114 of the definition information file 110 includes a condition 114 </ b> A that limits a numerical range (a numerical range of maximum “999” and minimum “−999”), and a character string of a value input to a parameter A condition 114B for specifying (a character string “0” to “9”) is defined. The check function generation unit 144 generates a numerical range determination code 103A for determining whether or not the value input to the parameter is within the range of “−999” to “999” from the condition 114A. Further, a character string determination code 103B for determining whether or not the value input to the parameter is a character string of “0” to “9” is generated from the condition 114B.
By using the input condition description code 103 generated in this way, the Web page input form 100 can perform parameter check of the value input in the input box 102A, and further enhance the convenience of confirming the operation of the API function. it can.

  Further, the input form generation unit 14 generates a button generation code 104 for generating a button 104A that prompts the operation of the Web page input form 100. In the present embodiment, as an example of the button 104A, an HTML code that displays a “query transmission button”, a “reset button”, and an “input check button” is generated. When the “query transmission button” is operated, the Web API function when the value input in the input box 102A is input as the parameter is executed. When the “reset button” is operated, the value input in the input box 102A is cleared. In addition, when the “input check button” is operated, the value input to the input box 102A is validated, that is, the value input to the input box 102A is checked in the option description section 114 of the definition information file 110. It is determined whether or not a specified condition is satisfied.

As described above, the input form generation unit 14 generates the source code (HTML) of the Web page input form 100 from the definition information file 110, thereby generating the Web page input form 100 shown in FIG. The input form generation unit 14 generates the Web page input form 100 from the definition information file 110 in accordance with a predetermined rule (program) stored in the storage unit 11.
The Web page input form 100 (Web page) generated by the input form generation unit 14 is provided to the library user terminal 4 (application developer) via the network, and receives input from the library user terminal 4.

Returning to FIG. 1, the parameter check execution unit 15, the function execution unit 16, and the execution result output unit 17 are functions implemented in the Web page input form 100 generated by the input form generation unit 14.
The parameter check execution unit 15 validates the value input in the input box 102A of the Web page input form 100, and determines whether or not the value satisfies a check specification condition. Specifically, the parameter check execution means 15 is based on the input condition description code 103 (check function) generated by the check function generation means 144 when a value is input to the input box 102A and the “input check button” is operated. Then, it is determined whether or not the value satisfies the check specification condition of the option description part 114 of the definition information file 110.

  The function execution means 16 inputs the value input in the input box 102A of the Web page input form 100 into the corresponding parameter, and executes the Web API function. Specifically, when the “query transmission button” is operated, the function execution unit 16 executes the Web API function based on the value input in the input box 102A. The Web API function is executed, for example, when the function execution unit 16 accesses the Web API library server 3 according to the address of the Web API function described in the Web API function description code 101 (FIG. 3).

  The execution result output means 17 outputs the execution result of the parameter check execution means 15 and the execution result of the function execution means 16 and transmits them to the library user terminal 4. At this time, if the output format is specified, the execution result output means 17 outputs the execution result in the specified output format. In the present embodiment, the execution result output unit 17 outputs the execution result in a format such as XML or JSON, for example.

FIG. 5 shows the input to the input box 102A of the web page input form 100 (FIG. 5 (1)) and the output result when the Web API function is executed based on the input value (FIG. 5 (2)). .
As described above, according to the Web API creation support apparatus 1, the application developer can check the execution result (operation) of the Web API function included in the Web API library by using the provided Web page input form 100. it can. In addition, since the Web page input form 100 can also determine whether or not the value input to the parameter satisfies the check designation condition, the convenience of checking the operation of the Web API function can be improved. Moreover, since the web page input form 100 is provided via the network in the form of a web page, the application developer can easily access the web page input form.

[Hardware Configuration of WebAPI Creation Support Device 1]
The hardware of the Web API creation support apparatus 1 described above can be configured by a general computer. For example, a general computer includes a central processing unit (CPU) as a control unit, and a memory (RAM, ROM), a hard disk (HDD), and an optical disk (CD, DVD, etc.) as a storage unit, and a network communication device. Various wired and wireless LAN devices as display devices, for example, various displays such as liquid crystal displays and plasma displays, and as input devices, for example, keyboards and pointing devices (mouse, tracking ball, etc.) Are connected by a bus line. In such a general computer, the CPU controls the Web API creation support apparatus 1 in an integrated manner, reads and executes various programs as appropriate, and cooperates with the above-described hardware, thereby providing various functions according to the present invention. Is realized.

[Processing of WebAPI creation support apparatus 1]
Next, processing of the Web API creation support apparatus 1 will be described with reference to FIG.

  S1: When a WebAPI library developer (library developer terminal 2) develops a WebAPI library, the WebAPI library is stored in the WebAPI library server 3 and a definition information file 110 of the WebAPI library is generated to support WebAPI creation. It is stored in the storage means 11 of the device 1.

S11: The update confirmation unit 12 confirms whether or not the definition information file 110 stored in the storage unit 11 has been updated.
S12: When the update is confirmed, the file reading unit 13 reads the definition information file 110 from the storage unit 11.
S13: Subsequently, the input form generation means 14 generates an HTML code for displaying the Web page input form 100 based on the read definition information file 110. At this time, the check function generation unit 144 of the input form generation unit 14 automatically generates the input condition description code 103 (check function) from the option description part 114 of the definition information file 110. When the input form generation unit 14 generates an HTML code for displaying the Web page input form 100, the Web API creation support apparatus 1 publishes the HTML code for displaying the generated Web page input form 100 so that the application developer can access it. To do.

  S21, S22: The application developer (library user terminal 4) accesses the Web page input form 100 and performs operations such as inputting a value into the input box 102A of the Web page input form 100.

S14, S15: The Web API creation support apparatus 1 performs parameter check and execution of a Web API function based on the operation of the application developer. That is, when the “input check” button is operated by the application developer, the parameter check execution unit 15 determines whether or not the value input in the input box 102A satisfies the check specification condition, and “query transmission”. When the button is operated, the function execution means 16 accesses the WebAPI library server 3 and executes the WebAPI function.
S16: Subsequently, the execution result output unit 17 transmits the execution result of the parameter check execution unit 15 and the execution result of the function execution unit 16 to the library user terminal 4.

  S23: When the execution result is received from the WebAPI creation support apparatus 1, the library user terminal 4 outputs (for example, displays on the display unit) the execution result.

  As mentioned above, although embodiment of this invention was described, this invention is not restricted to embodiment mentioned above. The effects described in the embodiments of the present invention are only the most preferable effects resulting from the present invention, and the effects of the present invention are limited to those described in the embodiments of the present invention. is not.

  For example, in the above-described embodiment, the storage unit 11 of the WebAPI creation support apparatus 1 stores the definition information file 110. However, the present invention is not limited to this, and the WebAPI creation support apparatus 1 (the update confirmation unit 12 and the file read-out) is not limited thereto. If the definition information file 110 is accessible to the definition information file 110, the storage means 11 of the WebAPI creation support apparatus 1 does not necessarily need to store the definition information file 110.

  Further, the Web API creation support apparatus 1 may have a function of transmitting the Web page input form 100 to the library user terminal 4. In such a case, parameters that are functions realized in the Web page input form 100 are provided. The library user terminal 4 has the check execution unit 15, the function execution unit 16, and the execution result output unit 17.

DESCRIPTION OF SYMBOLS 1 WebAPI creation assistance apparatus 11 Storage means 110 Definition information file 12 Update confirmation means 13 File reading means 14 Input form generation means 141 WebAPI function specification means 142 Input box generation means 143 Parameter specification means 144 Check function generation means 100 Web page input form 2 Library developer terminal 3 WebAPI library server 4 Library user terminal

Claims (4)

Definition information file of a WebAPI library, including a parameter description part describing each parameter of a plurality of WebAPI functions included in the WebAPI library, and an option description part describing a check specification condition of input information for the parameter An update checking means for checking file updates;
File reading means for reading out the definition information file whose update has been confirmed in response to the definition information file being updated;
An input box generating means for generating HTML code to display the parameter description of the definition information file read out by extracting the parameter, the number of the parameters extracted an input box for said parameter,
And checking function generating means for generating a check function that interprets the check specified conditions option description part of the definition information file read out, performs parameter check of the input information input to the input box,
HTML code for displaying a Web page input form having a test execution function of the WebAPI function based on the input information input to the input box and a parameter check function of the input information input to the input box based on the check function An input form generation means to generate;
A WebAPI creation support apparatus.   2. The Web API creation according to claim 1, further comprising: a parameter specifying unit that interprets a specification of an output format of the Web API function from a parameter description part of the definition information file and generates an HTML code that displays an input box reflecting the specification. Support device.   The Web API creation support apparatus according to claim 1, wherein the input form generation unit generates an HTML code for displaying the Web page input form in a Web page format that can be browsed via a network. A given computer runs,
Definition information file of a WebAPI library, including a parameter description part describing each parameter of a plurality of WebAPI functions included in the WebAPI library, and an option description part describing a check specification condition of input information for the parameter A step to check for file updates;
Reading the definition information file whose update has been confirmed in response to the definition information file being updated;
And generating a HTML code to display the parameter description of the definition information file read out by extracting the parameter, the number of the parameters extracted input box for the parameter,
Generating a check function that interprets the check specified conditions option description part of the definition information file read out, performs parameter check of the input information input to the input box,
HTML code for displaying a Web page input form having a test execution function of the WebAPI function based on the input information input to the input box and a parameter check function of the input information input to the input box based on the check function Generating step;
WebAPI creation support method including

Images