TWI767644B - System for setting data structure and automatically generating application programming interface service information - Google Patents

Abstract

A system that automatically generates application programming interface service information through setting data structure is capable of providing a more user-friendly interface for the clients to design their own data field structure parameter to automatically generate application programming interface (API, which is an information interface for data transmission service) service information, automatically generate data management and control function interface and automatically generate corresponding code so that the development and integration of applications will be more efficient on the application development end.

Description

By setting the data structure and automatically generating API service information system

The present invention relates to a system for automatically generating application programming interface service information by setting a data structure, especially a system that can respond to the normal changes of the data structure and data of the client, and provide a more user-friendly client that can be designed by itself. Data field structure parameter interface, automatic generation of application programming interface service information (Application Programming Interface, API, information interface for data transmission services), and automatic generation of data management control function interface Design system.

Databases are used to store and manage multiple pieces of data, and have been widely used in systems such as e-commerce or personnel management. When building a database, it is first necessary to determine the structure of the database, including the number of data tables in the database, the fields of each data table, and the associations between the various fields in the data table.

Database development usually requires people who have a certain understanding of programming languages in order to design a reasonable and usable database system. If the design of the fields of the data table in the database is unreasonable, or there is a logical relationship between the fields Due to the errors of nature, unexpected errors occur in the database application system, so this is often not something that ordinary people can design by themselves.

Therefore, if it is possible to provide an intuitive way for users to design database fields in a specific way of clicking and inputting data, it will effectively reduce the complexity of database design, and also allow users who do not have a programming background to use However, even if the programming language cannot be used flexibly, the database fields can be designed in a systematic and intuitive manner provided by this case, so the present invention should be an optimal solution.

The present invention uses a system for setting data structure and automatically generating application programming interface service information, which is set on an electronic device, and the electronic device has at least one processor and at least one computer-readable recording medium, and the computer can read The recording medium stores at least one data structure field design application, wherein the computer-readable recording medium further stores computer-readable instructions, which, when executed by the processors, cause the computer-readable instructions The electronic device performs the following procedures: in a user interface of the activated data structure field design application program, by setting (inputting, selecting or setting) at least one data field information and at least one field parameter information, and Can generate an application programming interface service information (Application Programming Interface, API, information interface for data transmission service).

More specifically, the field design application unit includes at least: a project creation module for creating at least one or more project files, wherein the content of each project file includes at least one data field information and At least one field parameter information; a data field setting module, which is connected with the project establishment module, is used to set at least one or more data field information to be created in any one or any plurality of project files A new database field is created; a field parameter setting module is connected to the data field setting module, and is used to set at least one or more field parameter information for any one or more The internal parameter definitions are set in the database field in the project file; a service generation module, It is connected with the project establishment module to generate the content of the project file as at least one Application Programming Interface (API, the information interface for data transmission service); and a management control interface is generated The module is connected with the project establishment module, and is used for generating the content of the project file as at least one user control interface.

More specifically, the user control interface can be stored in a database storage device and can be accessed into the database storage device through the API service information connection to view the created user control interface .

More specifically, the field design application unit further includes a data code generation module, wherein the data code generation module is connected with the project establishment module for generating the content of the project file as a data code.

More specifically, the data code generated by the data code generation module is a back-end data code or/and a front-end data code, the back-end data code is C language, and the front-end data code is It is the Javascript language.

More specifically, the API service information that the service generation module can generate can be data reading API service information, data writing API service information, data updating API service information, and data deletion. API Service Information or/and Data Field Information API Service Information.

More specifically, the user control interface that can be generated by the management control interface generation module includes functions such as data reporting, data retrieval, data export and import, data addition, data modification, data deletion or/or and file upload and download.

More specifically, the data field information is at least field verification setting information, field enable/disable information, field corresponding API permission setting information or/and field corresponding management interface setting information. News.

More specifically, the field parameter information is at least enable/disable information, data access authority information or/and collaborative access authority information.

1: Electronic equipment

11: Processor

12: Computer-readable recording medium

121: Data Structure Field Design Application

1210: User Interface Management Module

12101: User Interface

1211: Project Creation Module

1212: Data field setting module

1213: Field parameter setting module

1214: Service Generation Module

1215: Management control interface generation module

1216: Data code generation module

2: Database storage device

3: Electronic device

[Fig. 1] is a schematic diagram of the overall structure of the system of the present invention through setting the data structure and automatically generating application programming interface service information.

[Fig. 2] is a schematic diagram of the structure of an application program designed through the data structure field of the system for setting the data structure and automatically generating application programming interface service information according to the present invention.

[Fig. 3A] is a schematic diagram of the implementation and application of the present invention through the system of setting data structure and automatically generating API service information.

[FIG. 3B] is a schematic diagram of the implementation and application of the present invention through the system of setting data structure and automatically generating API service information.

[FIG. 3C] is a schematic diagram of the implementation and application of the present invention through the system of setting data structure and automatically generating API service information.

[FIG. 3D] is a schematic diagram of the implementation and application of the present invention through the system of setting data structure and automatically generating API service information.

[Fig. 3E] is a schematic diagram of the implementation and application of the present invention through the system of setting data structure and automatically generating API service information.

Other technical contents, features and effects of the present invention will be clearly presented in the following detailed description of the preferred embodiments with reference to the drawings.

Please refer to Figures 1 and 2, which are the overall architecture diagram of the system for setting data structure and automatically generating application programming interface service information and the architecture diagram of the data structure field design application program. It can be seen from the figures that the A system for setting data structures and automatically generating application programming interface service information can be installed on an electronic device 1, and the electronic device 1 has at least one processor 11 and at least one computer-readable recording medium 12, the computers The readable recording medium 12 stores at least one data structure field design application 121 , wherein the computer readable recording medium 12 further stores computer readable instructions, when the processors 11 execute the computer readable instructions. When the instruction is read, the electronic device 1 is caused to perform the following procedures: in a user interface of the activated data structure field design application 121, at least one data field information and at least one field parameter information can be set, And can generate an application programming interface service information (Application Programming Interface, API, information interface for data transmission services).

The electronic device 1 can be a server device, and the user can connect to the electronic device 1 through a personal device (laptop, desktop computer, smart phone or tablet), and can also log in to a user The account number to design the data structure field through the user interface provided by the data structure field design application 121 .

Therefore, the data structure field design application 121 can further set up user accounts with different user rights, so as to provide different users with different functions. Besides, the content of each created project file is more It can be opened to allow multiple user accounts to edit and modify, so as to provide the function that multiple people can edit data structure fields.

Therefore, the client can operate and set data fields through the interface provided in this case. The database field generation is performed synchronously on the server side (that is, the electronic device 1), and the automatic calculation is performed synchronously on the logic operation side to generate application programming interface (API, information interface for data transmission services), Automatic calculation generates a data management control function interface, and automatic calculation generates corresponding code for data transmission between the server and the client.

The data structure field design application 121, as shown in FIG. 2, at least includes: (1) a user interface management module 1210 for providing a plurality of user interfaces, allowing users to The interface is used to design application units using the field; (2) a project creation module 1211 is used to create at least one or more project files, wherein the content of each project file includes at least one data field information and at least one field parameter information; (3) a data field setting module 1212, which is connected to the project establishment module, and used to set at least one or more data field information to be used in any one or any plurality of project files A new database field is created within the data field, wherein the data field information is at least the field authentication setting information, the field enable/disable information, the field corresponding API permission setting information or/and the field corresponding management interface setting information ; (4) a field parameter setting module 1213, which is connected to the data field setting module for setting at least one or more field parameter information to be used in any one or more project files. The internal parameter definition is set in the database field, wherein the parameter information in this field is at least enable/disable information, data access authority information or/and collaborative access authority information; (5) a service generation module 1214 , is connected with the project establishment module to automatically generate the content of the project file as at least one Application Programming Interface (API, information interface for data transmission services), wherein the generated API service information is able to read API service information for data, write data to API service information, update data to API service information, delete data to API service information information or/and data field information application programming interface service information; (6) a management control interface generation module 1215, which is connected with the project establishment module to automatically generate the content of the project file as at least one A user control interface, wherein the user control interface can be stored in a database storage device and can be accessed through the application programming interface service information connection in the database storage device to view the created user control interface , and the generated user control interface contains functions that can be data reporting, data retrieval, data export and import, data addition, data modification, data deletion or/and file upload and download; (7) a data code The generation module 1216 is connected with the project establishment module, and is used for automatically generating the content of the project file into a data code, the data code being the back-end data code or/and the front-end data code, The back-end data code is in C language (C#), and the front-end data code is in Javascript language.

To further explain the field type, field attribute and corresponding programming language defined in this case, the description is as follows:

1. Field type:

(1) Text Text string

single line text field

(2) Text block TextArea string

multiline text block

(3) Digital Int int

Number format field

(4) Whether Bool boolean

boolean field

(5) Date date

date format field

(6) Date Time DateTime datetime

datetime format field

(7) E-mail Mail string

Email Format Fields

(8) Local or mobile PhoneMobile string

Local call or mobile phone format field

(9) Local Phone string

Local call format field

(10)Mobile string

Mobile phone format field

(11) URL Url string

URL pattern field

(12) DropDownList string

drop down menu

(13) Multiple selection list CheckBoxList string[]

Multiple choice check box

(14) RadioButtonList string

single check box

(15) Upload file UploadFile string｜blob

Select file upload field

(16) Upload image file UploadImage string｜blob

Select file upload field

(17) Associated field BindField string|string[]

Associated Unit Data

Drop-down menu｜Multiple selection check boxes｜Single selection check boxes

(18) Associated field second-order Bind2Field string(value1; value2)

Double-Associated Unit Data

Double drop down menu

(19) Editor string | html encode

HTML format editor

(20) HiddenField string

hide field

2. Field properties:

(1) Field KEY key string

The field identifies the unique key value; the API returns the data field KEY name

(2) Field name name string

Unit data management field name; embedded form and report field name; not repeatable

(3) Data format type string｜FieldType

Data field type; see Field Types for details

(4) The verification field must be filled with required Boolean

true: verify | false: do not verify

(5) The verification data cannot be repeated validExist Boolean

true: verify | false: do not verify

(6) The form field is read-only readOnly Boolean

true: the field cannot be entered | false: the field can be entered

(7) Regular expression verification regex string

Form Field Validation Regular Expression

(8) The initial value of the form field initValue string

Form field default brings in initial value

(9) Form field description remark string

Form field remarks or prompts

(10) The maximum length of text textMaxLength int

Form field text maximum length limit and validation

(11) The minimum value of the digital field intMini string

Numeric field validation allows minimum value

(12) The maximum value of the digital field intMax string

Number Field Validation Maximum Allowed

(13) Select field item item json|array[object]

Field Type: Drop-Down Menu | Multiple Choice List | Single Choice List

item text text string

item value value string

EX:

[{"text":"Nong","value":"1"},{"text":"Work","value":"2"},{"text":"Scholar","value": "3"},{"text":"quotient","value":"4"}]

(14) Associated field setting value bindField json｜object

Field Type: Associated Field

Associated project resource identifier Project_token string

Associated unit resource identifier ProjectUnit_token string

Associated unit field KEYProjectUnitField_key string

filterField filterField string

filter method filterFieldType string

unfiltered | equal to value | contains value

filter value filterFieldValue string

sort field sortField string

Sort by sortFieldType string

Item sorting; positive order (ASC) | reverse order (DESC)

style style string

Field Type: Drop-Down Menu | Multiple Choice List | Single Choice List

EX:

{"Project_token":"8c13e3dbdbad444ba07d4ad154823e0x","ProjectUnit_token":"39580a74845245dab38caf2425121dcx","ProjectUnitField_key":"field_1","filterField":"","filterFieldType":"","filterFieldValue":"","sortField": "field_3", "sortFieldType": "ASC", "style": "RadioButtonList"}

(15) The second-order setting value of the associated field bind2Field json｜object

Field Type: Linked Field Second Order

Associated (1|2) project resource identifier

Project1_token string

Project2_token string

Associated (1|2) Unit Resource Identifier

ProjectUnit1_token string

ProjectUnit2_token string

Associated (1|2) unit field KEY

ProjectUnitField1_key string

ProjectUnitField2_key string

Associated (1|2) filter field

filterField1 string

filterField2 string

Association (1｜2) filter method

filterField1Type string

filterField2Type string

unfiltered | equal to value | contains value

Associate (1|2) filter value

filterField1Value string

filterField2Value string

Associated (1|2) sort field

sortField1 string

sortField2 string

Association (1|2) Sorting Method

sortField1Type string

sortField2Type string

Item sorting; positive order (ASC) | reverse order (DESC)

EX:

{"Project1_token"："8c13e3dbdbad444ba07d4ad154823e0x","ProjectUnit1_token"："39580a74845245dab38caf2425121dcx","Project2_token"："8c13e3dbdbad444ba07d4ad154823e0d","ProjectUnit2_token"："57d70b3c6fae4da48f61ba04bd4ccf7e","ProjectUnit1Field_key"："field_1","ProjectUnit2Field_key"："field_1"," filterField1":"","filterField1Type":"","filterField1Value":"","sortField1":"","sortField1Type":"ASC","filterField2":"","filterField2Type":""," filterField2Value":"","sortField2":"","sortField2Type":"ASC"}

(16) Upload file field setting value file json｜object

Field type: upload file | upload image file

file maximum limit maxSize int

Field Validation Upload File Size (MB) and Limit

The default value of 0 is unlimited

file format restriction extension string

Field Validation Upload File Format and Restrictions

System default and allow uploadable format

Format: .jpg.jpeg.png.gif.bmp.txt.pdf.doc.docx.xls.xlsx.ppt.pptx

EX:

{"maxSize": 0, "extension": ".jpg.jpeg.png.gif.bmp"}

(17) Upload image field setting value image json｜object

Field type: upload image file

image fixed width width int

Fields verify that the uploaded image is equal to the width and limit

The default value of 0 is unlimited

Image fixed height height int

Fields verify that the uploaded image is equal to the height and limit

The default value of 0 is unlimited

Image maximum width maxWidth int

Field Validation Upload Image Allowed Maximum Width and Limit

The default value of 0 is unlimited

Image maximum height maxHeight int

Field validation upload image maximum allowed height and limit

The default value of 0 is unlimited

EX:

{"width": 0, "height": 0, "maxWidth": 0, "maxHeight": 0}

(18) Column sort sort int

Form Field Order｜Report Field Order｜API Return Data Field Order

(19) The report column displays colShow Boolean

true: show | false: not show

(20) Report column width colWidth int

The default value of 0 is automatic width; unit: px

(21) The report field is symmetrical colAlign string

The default value (Center) is center; setting value: Center|Left|Right

(22) Report sorting method tbSortType string

Report column data sorting; positive order (ASC) | reverse order (DESC)

(23) Report preset sorting tbSort Boolean

true: Set report field data sorting | false: Do not set report field data sorting

(24) Report sorting priority tbSortPriority int

Report field data sorting set priority order

(25) Allow API to write apiAdd Boolean

true: allowed | false: not allowed

(26) Allow API to modify apiUpdate Boolean

true: allowed | false: not allowed

(27) Allow API to read apiRead Boolean

true: allowed | false: not allowed

(28) Allow API to delete apiDelete Boolean

true: allowed | false: not allowed

(29) field enable enable Boolean

true: enable | false: disable

And when the electronic device 1 is connected to the electronic device 1 through an electronic device 3, it can be operated on the user interface 12101, and then log in to an account to log in to the system of this case, and then a project file must be opened (and a connection must be made at the same time). Enter the database storage device 2 or directly use the local device as the data Library field storage location), and as shown in Figure 3A, you can set parameters in the project file (whether to allow API connection, allow API connection time, API verification Captcha, whether to display data creation time in the background, whether to The data modification time is displayed in the background, whether the last modified person is displayed in the background, whether the data key value is displayed in the background, whether it is collaborative management, whether it is enabled, and the remark content); after that, the field design can be further carried out, as shown in Figure 3B, here It can be edited and added according to the user's needs (the editable and new contents are: field KEY name, field name, field arrangement order, data format, whether the field must be filled in, whether the form field is not Required, whether the data is non-repeatable, whether the form field is read-only, whether the report field is displayed, the report field style, the report arrangement, whether the report is sorted by default, whether the report is sorted first, whether to allow API reading, whether to allow API writing input, whether to allow API modification, whether to allow API deletion, whether to enable the field, whether to delete the field); and the editing of each field, as shown in Figure 3C, can be based on input and modification, and after the modification is completed, then It can be displayed on the screen as shown in Fig. 3B.

When the parameter setting and field design are completed, the API information (as shown in Figure 3D) and the user control interface (as shown in Figure 3E) will be generated, including the API key, API address (read Get multiple data, read single data, add single data, modify single data, delete single data, field data, the fogged area in the picture represents the address of database storage) and Captcha graphics Javascript sample and C# sample can be generated in the API address, and the Captcha image and text address can download the SQL structure, SQL structure and data. In addition, when you click on the data report in the API address, you can view a single transaction After the data report, blank form, editable data report, and delete data report, the corresponding data management control function interface can be presented.

In addition, through the system in this case, the client serves information through the application programming interface (Application Programming Interface, API) or data management control interface, which can transmit data or media files to the server-side database and storage in real time, and can also access the server-side data and files in real time.

In addition, through the system of this case, the security access authority and data verification related to data and file transmission between the client and the server are also operated and set through the user interface, and the parameters are set on the server according to the user. Perform real-time logical calculus processing.

Compared with other conventional technologies, the system provided by the present invention through setting data structure and automatically generating application programming interface service information has the following advantages:

(1) The present invention can respond to the normal changes of the customized data structure and data of the user terminal, and provide a more user-friendly user terminal that can design the data field structure parameter interface by itself, and automatically generate the application programming interface service information (Application Programming Interface, API, information interface for data transmission service), and automatically generate data management control function interface, and automatically generate corresponding code to provide application development side with more efficient development and integration of applications.

(2) The present invention can stream the received data and its media files through the automatically generated Application Programming Interface (API, the information interface for data transmission services) or the data management control interface. , stored in the server-side database and storage.

(3) The present invention can automatically generate application programming interface service information (Application Programming Interface, API, the information interface for data transmission services) of the data files that have been stored in the server database and storage body, or control the data through data management Interface for data transfer generation.

(4) The present invention enables the client to design the data field and set the field type by itself, and set the field Related parameters, including data authentication, data access and change permissions, data management control interface settings, simple and fast construction of data management function interface, automatic generation of API services.

The present invention has been disclosed above through the above-mentioned embodiments, but it is not intended to limit the present invention. Anyone familiar with this technical field with ordinary knowledge can understand the aforementioned technical features and embodiments of the present invention without departing from the present invention. Within the spirit and scope, some changes and modifications may be made, so the scope of patent protection of the present invention shall be determined by the claims attached to this specification.

1: Electronic equipment

11: Processor

12: Computer-readable recording medium

121: Data Structure Field Design Application

2: Database storage device

Claims (9)

A system for automatically generating application programming interface service information by setting a data structure is provided on an electronic device, and the electronic device has at least one processor and at least one computer-readable recording medium, and the computer can read the recording The medium stores at least one data structure field design application, wherein the computer-readable recording medium further stores computer-readable instructions, which, when executed by the processors, cause the electronic The device performs the following procedures: in a user interface in the activated data structure field design application program, can generate an application program interface service by setting at least one data field information and at least one field parameter information News. The system for setting a data structure and automatically generating application programming interface service information as described in claim 1, wherein the data structure field design application program comprises at least: a project creation module for creating at least one or more project file, wherein the content of each project file includes at least one data field information and at least one field parameter information; a data field setting module is connected with the project establishment module for setting at least one or Multiple data field information to create a new database field in any one or more project files; a field parameter setting module is connected to the data field setting module for Setting at least one or more fields of parameter information to set the internal parameter definitions in any one or more database fields in the project file; a service generation module, which is related to the project creation module A connection is used to generate at least one API service information according to the content of the project file; and a management control interface generation module is connected with the project establishment module, and is used to generate the content of the project file as at least one A user control interface. The system for setting a data structure and automatically generating application programming interface service information as described in claim 2, wherein the user control interface can be stored in a database storage device and can be generated by the service generation module The API service information is connected into the database storage device for viewing the user control interface created by the management control interface generation module. The system for setting a data structure and automatically generating application programming interface service information as described in claim 2, wherein the data structure field design application further includes a data code generation module, wherein the data code generation module is a Connect with the project establishment module to generate the content of the project file as a data code. The system for setting data structure and automatically generating application programming interface service information as described in claim 4, wherein the data code generated by the data code generation module is a back-end data code or/and a front-end data code, The back-end data code is in C language, and the front-end data code is in Javascript language. The system for automatically generating application programming interface service information by setting a data structure and automatically generating application programming interface service information as described in claim 2, wherein the application programming interface service information that the service generation module can generate is capable of reading application programming interface service information, data writing Enter API Service Information, Data Update API Service Information, Data Delete API Service Information or/and Data Field Information API Service Information. The system for setting data structure and automatically generating application programming interface service information as described in claim 2, wherein the user control interface that can be generated by the management control interface generating module includes functions such as data reporting, data retrieval, data Export and import, data addition, data modification, data deletion or/and file upload and download. The system for automatically generating application programming interface service information by setting a data structure as described in claim 1, wherein the data field information is at least field verification setting information, field enable/disable information, and field corresponding API permission settings The information or/and field corresponds to the management interface setting information. The system for automatically generating application programming interface service information by setting a data structure as described in claim 1, wherein the field parameter information is at least enable/disable information, data access authority information or/and collaborative access authority information.

Images