Software back-end interface low-code interface design method

Abstract

The invention provides a software framework design, interface design and function planning method which is suitable for developing tool type software. According to the method, a pure code development mode of a traditional software back-end interface is converted into a low code development mode, common generality functions in back-end interface development are achieved through interface visualization setting, key service functions are achieved by means of independent script editing, the working process of back-end interface development and maintenance can be greatly simplified, and the development efficiency of the back-end interface is improved. And the design is excellent and innovative.

Description

Technical Field

[0001] This invention relates to the field of software technology, and more specifically, to a design method for a software framework, interface, and functions. Background Technology

[0002] In conventional software development tools, backend interfaces are primarily represented by plain code files. While this design offers good flexibility, it can lead to a significant amount of repetitive and tedious work in certain use cases. Furthermore, in conventional software development, backend interfaces require compilation and deployment to function, which undoubtedly increases the workload for maintenance and upkeep. Summary of the Invention

[0003] In view of this, the purpose of this invention is to provide a software framework design, interface design method, and function planning to solve the above problems.

[0004] The overall concept of this invention is to construct a low-code framework, interface, and functional design system, extracting common and repetitive functions from the software backend interface and implementing them at the framework layer; breaking down the backend interface into several key modules, and implementing these functions through a visual interface configuration; core business rules are implemented through code scripts written via the interface. In all these steps, changes take effect immediately simply by saving and publishing through the interface.

[0005] The advantages of this invention are: by providing a framework and a visual interface, it enables repetitive and common functionalities in the backend interface, allowing users to focus only on writing business rules, thereby reducing the workload of developing and maintaining the software backend interface.

[0006] To make the above-mentioned objects, features and advantages of the present invention more readily understood, preferred examples are described below in detail with reference to the accompanying drawings. Attached Figure Description

[0007] To more clearly illustrate the design scheme of this invention, the accompanying drawings used in this invention will be briefly described below. It should be understood that the following drawings only show some examples of this invention and should not be considered as limiting the scope of protection. For those skilled in the art, other related drawings can be obtained from these drawings without any inventive effort.

[0008] Figure 1 A schematic diagram of the structure of a low-code framework for a software backend interface provided as a preferred example of the present invention.

[0009] Figure 2 A schematic diagram of the interface design of the low-code SQL method for the software backend interface provided as a preferred example of the present invention.

[0010] Figure 3A schematic diagram of the interface design of the low-code interface method for the software backend interface provided as a preferred example of the present invention.

[0011] Figure 4 This is a schematic diagram of the interface design of a low-code data entity for a software backend interface, which is a preferred example of the present invention. Detailed Implementation

[0012] The technical solution of the present invention will now be clearly and completely described with reference to the accompanying drawings. Obviously, the description only covers some specific details of the invention. Generally, the designs described and shown in the accompanying drawings can be arranged and designed in many different configurations. Therefore, the following detailed description of the examples of the invention provided in the accompanying drawings is not intended to limit the scope of the claimed invention, but only represents selected design schemes of the invention. All other examples obtained by those skilled in the art based on the examples of the invention without inventive effort are within the scope of protection of the present invention.

[0013] Note that similar reference numerals and letters represent similar items in subsequent figures. Therefore, once an item is defined in one figure, it need not be redefined and explained in subsequent figures. Furthermore, in the description of this invention, unless otherwise expressly specified and limited, the terms "attribute," "setting," "operation," "connection," and "call" should be interpreted broadly, and their specific meanings can be determined by those skilled in the art in light of the actual circumstances.

[0014] The low-code framework design for the backend interface mentioned in this invention is as follows: Figure 1 As shown: The software backend interface is connected to each business interface (A101) by a unified business interface access control (A100); each business interface consists of three parts: interface method (A104), SQL method (A103), and data entity (A102), and all three parts are implemented through a visual interface.

[0015] Business Interface Access Control (A100) provides unified interface access functionality, covering common framework functions including: interface authentication, interface access traffic control, interface version control, and interface access logging.

[0016] The business interface (A101) supports the coexistence of multiple interfaces, each of which can be edited independently, and the business interfaces can be called through the business interface access control framework. Each business interface consists of three parts: an interface method, an SQL method, and a data entity, where the interface method is the smallest publicly exposed unit of invocation.

[0017] Interface Method (A104): A business interface contains multiple interface methods. Interface methods within the same business interface can call each other. Its main operations include refresh, save, publish, as well as download and upload interface configuration.

[0018] SQL Methods (A103): A business interface contains multiple SQL methods. SQL methods cannot call each other, but they can be called within the interface methods. The interface methods complete database read and write operations by calling the SQL methods.

[0019] Data Entities (A102): A business interface contains multiple data entities, which mainly define the entity names and fields used by SQL methods and interface methods. They can provide field-level code hints during the script editing process of interface methods and SQL methods, and provide the selection and display functions of entity names and fields during the visual operation of the interface.

[0020] The interface design of the low-code SQL method for the software backend interface mentioned in this invention is as follows: Figure 2 As shown, the SQL method editing interface mainly includes: SQL method related operations (B100), SQL method list (B101), SQL method properties (B102), input parameter definition (B103), SQL script (B104), pagination row number SQL script (B105), dynamic SQL condition processing script (B106), insert SQL script (B107), and update SQL script (B109).

[0021] SQL method-related operations (B100) mainly include: adding, deleting, copying, pasting, and sorting by name in the SQL method list, as well as the method execution function, which is used for unit development and debugging of SQL methods.

[0022] The SQL method list (B101) displays all SQL methods in a list view. When a specific SQL method is selected, its detailed information will be displayed on the right side of the interface, allowing for editing.

[0023] The SQL method properties (B102) mainly include: SQL method description, data source, database type, method type, and return type. The method type property covers pagination queries, list queries, object queries, field queries, inserts, edits, deletes, and saves. The selection of the method type affects the display and editing logic of the subsequent script editing interface. For example, selecting the save method will display and allow editing of dynamic SQL condition processing scripts, insert SQL scripts, and update SQL scripts.

[0024] The input parameter definition (B103) is used to define the parameter variables required by the SQL method. It is presented in a table view and includes fields such as parameter name, parameter type, data type, and default value. The main operations include adding, deleting and selecting commonly used parameters.

[0025] The SQL script (B104) is used to write SQL script statements corresponding to operations specified by the method type attribute. The main operations include SQL generation, code formatting, and field hints during script writing.

[0026] The pagination row count SQL script (B105) is used to write SQL script statements to get the total number of rows in a page when the method type attribute is pagination query. The main operations include SQL generation, code formatting, and field hints during script writing.

[0027] The Dynamic SQL Condition Processing Script (B106) is used to write code scripts to process dynamically concatenated SQL query parameters. The main operations include selecting common code snippets and formatting code.

[0028] The Insert SQL Script (B107) is used to write Insert SQL script statements with the method type attribute set to save. The main operations include SQL generation, code formatting, and field hints during script writing.

[0029] The update SQL script (B109) is used to write update SQL script statements when the method type attribute is saved. The main operations include SQL generation, code formatting, and field hints when writing the script.

[0030] The interface design of the low-code interface method for the software backend mentioned in this invention is as follows: Figure 3 As shown, the interface method editing interface mainly includes: interface method related operations (C100), interface method list (C101), interface method properties (C102), input parameter definition (C103), output parameter definition (C104), and business processing script (C105).

[0031] Interface method related operations (C100) mainly include: adding, deleting, copying, pasting, and sorting by name in the interface method list, as well as the method execution function, where method execution is used for unit development and debugging of interface methods. Interface method list (C101): Displays all interface methods in a list view. When any interface method is selected, the right side of the interface will display the detailed information of that interface method and support editing operations.

[0032] Interface method attributes (C102): mainly include interface method description, whether it is public, whether transaction control is enabled, whether it is asynchronous, whether it returns paginated data, and whether it returns encrypted messages.

[0033] Input Parameter Definition (C103): Defines input parameters for interface methods through a list view, supporting operations such as adding, deleting, copying, pasting, and selecting commonly used parameters; parameter attribute editing covers parameter name, description, data type, whether it is required, default value, validation rules, and validation instructions. Visually configuring parameter validation rules can effectively reduce the amount of business processing code.

[0034] Output Parameter Definition (C104): Defines the output parameters of interface methods through a list view, supporting operations such as adding, deleting, copying, pasting, and selecting commonly used parameters; parameter attribute editing includes parameter name, description, and data type. Visual configuration allows for the blocking and filtering of fields that are not publicly disclosed.

[0035] Business Processing Script (C105): Used to write code scripts for business processing. It supports operations such as selecting commonly used code snippets, generating code to create data entities, generating code to call business interfaces, formatting code, and code suggestions when writing scripts.

[0036] The low-code data entity interface design for the software backend mentioned in this invention is as follows: Figure 4 As shown, the data entity editing interface mainly includes data entity-related operations (D100), data entity list (D101), data entity attributes (D102), field list (D103), and field attributes (D104).

[0037] Data entity related operations (D100): mainly include adding, deleting, copying, pasting, and sorting by name of data entities, as well as generating SQL methods, interface methods, and creating data table SQL based on data entities.

[0038] Data Entity List (D101): Displays all data entities in a list view. When any data entity is selected, its detailed information will be displayed on the right side of the interface, and editing is supported.

[0039] Data entity attributes (D102): mainly include description, data table to which it belongs, etc.

[0040] Field List (D103): Displays all fields of the current data entity in a list view. When any field is selected, the right side of the interface will display the detailed information of that field and support editing operations.

[0041] Field attributes (D104): mainly include field name, field description, field type, object type, remarks, table column, data type, data length, whether it is a primary key, whether it is auto-increment, whether to ignore it during INSERT, whether to ignore it during UPDATE, whether it is a foreign key, foreign key table, foreign key column, etc.

[0042] In summary, the low-code interface design method for software backend interfaces provided by this invention solves common functions in backend interface development through visual interface settings and implements key business functions through independent script editing. It can greatly simplify the workflow of backend interface development and maintenance, and is an excellent and innovative design.

[0043] In the examples provided in this application, it should be understood that the disclosed interface design and functional planning can also be implemented in other ways. The examples described above are merely illustrative; for example, the block diagrams in the accompanying drawings illustrate possible implementation architectures, interface functions, and operation flows of designs, methods, and computer program products according to examples of the present invention. In this regard, each block in the block diagram may represent an interface module, program segment, or code fragment, containing one or more executable instructions for implementing a specified logical function. It should also be noted that in some alternative implementations, the functions marked in the blocks may be executed in a different order than those marked in the accompanying drawings.

[0044] It should be noted that the terms "comprising," "including," or any other variations thereof used herein are intended to cover non-exclusive inclusion, such that a process, method, article, or apparatus that comprises a list of elements includes not only the elements expressly listed but also other elements not expressly listed, or elements inherent to the process, method, article, or apparatus. Unless otherwise specified, an element defined as "comprising one..." does not exclude the presence of other identical elements in the process, method, article, or apparatus that includes that element.

[0045] The above description is merely a preferred example of the present invention and does not constitute a limitation thereof. For those skilled in the art, various modifications and variations can be made to the present invention. Any modifications, equivalent substitutions, improvements, etc., made within the spirit and principles of the present invention should be included within the scope of protection of the present invention. It should be noted that similar reference numerals and letters in subsequent drawings indicate similar items; therefore, if an item has already been defined in one drawing, it does not need to be further defined and explained in subsequent drawings.

Claims

1. A software framework, interface, and function design method suitable for tool-type software development, comprising a low-code interface for business interface methods, a low-code interface for SQL methods, a low-code interface for data entities, and a framework design and function planning method supporting the operation of the interface functions. The low-code interface for business interface methods is used for visually editing and managing all interface methods of the business interface. The low-code interface for SQL methods of the business interface is used for visually editing and managing all SQL methods of the business interface. The low-code interface for data entities of the business interface is used for visually editing and managing all data entities of the business interface. The framework design and function planning method supporting the operation of the interface functions is used to support the implementation of functions and framework encapsulation required for interface operation.

2. The design method according to claim 1, characterized in that, A business interface comprises multiple interface methods, multiple SQL methods, and multiple data entities. Their roles and relationships are as follows: Interface methods are the smallest publicly accessible calling units, and they can call each other. SQL methods are the smallest calling units for database read / write operations; SQL methods cannot call each other and must be called through interface methods to complete data read / write operations. Data entities provide field code hints and field selection support when editing interface and SQL methods. SQL methods and interface methods can be generated unidirectionally through data entities.

3. The design method according to claim 1, characterized in that, The core elements of the low-code interface for business API methods include API method attributes, input parameter definitions, output parameter definitions, and business processing scripts. The API method attributes are used for visually setting the properties of the API method, mainly including whether it is public, whether transaction control is enabled, whether it is asynchronous, whether the returned message is encrypted, and whether it returns paginated data. The input parameter definition is used for visual editing and management of all input parameters of the interface method, and allows setting required fields and validation rules for each parameter; by visually configuring parameter validation rules, the amount of business processing code can be effectively reduced. The output parameter definition is used for visual editing and management of all output parameters of the interface method. By configuring visual parameters, fields that are not publicly disclosed can be blocked and filtered.

4. The design method according to claim 1, characterized in that, The core elements of the low-code interface for the SQL methods of the business interface include SQL method attributes, input parameter definitions, SQL scripts, pagination row count SQL scripts, dynamic SQL condition processing scripts, insert SQL scripts, and update SQL scripts. The SQL method attributes mainly include the SQL method description, data source, database type, method type, and return type. The method type attribute covers pagination query, list query, object query, field query, insert, edit, delete, and save; the selection of the method type affects the subsequent display and editing logic of the script editing interface. The input parameter definitions are used for visual editing and management of all input parameters of the SQL method. The SQL scripts are used to write SQL script statements corresponding to the operations specified by the method type attributes. The pagination row count SQL script is used to write SQL script statements to obtain the total number of rows per page when the method type attribute is pagination query. The dynamic SQL condition processing script is used to write code scripts to process dynamically concatenated SQL query parameters. The insert SQL script is used to write insert SQL script statements when the method type attribute is save. The update SQL script is used to write update SQL script statements when the method type attribute is save.

5. The design method according to claim 4, characterized in that, The method type of the SQL method attribute is the interface elements and functional rules when saving. The SQL method can be used to edit SQL scripts, insert SQL scripts and update SQL scripts through the interface. The SQL method can make a judgment based on the result of the SQL script. If the data row does not exist, the insert SQL script will be executed. If the data row exists, the update SQL script will be executed. This design can effectively reduce the amount of business logic code.

Images