CN116755684A - OAS Schema generation method, device, equipment and medium - Google Patents

Abstract

The application provides a method, a device, equipment and a storage medium for generating an OAS Schema, and relates to the technical field of software development. The method comprises the following steps: analyzing the class file, and acquiring information related to the class from the analyzed file; traversing information related to the class generates a data model of the OAS. The implementation of the application can analyze the class image file, automatically generate the OAS Schema according to the analysis result, specifically analyze the plant UML class image file, generate the OAS Schema according to the analysis result, and quickly generate the OAS file comprising interfaces for adding, deleting, modifying and checking the OAS Schema through the OAS Schema, thereby reducing the workload of manual writing and maintenance, having short time consumption, improving the development efficiency, and being capable of quickly iterating and modifying, and reducing the possibility of inconsistent OAS Schema and the field model.

Description

OAS Schema generation method, device, equipment and media

Technical field

This application relates to the technical field of software development. Specifically, this application relates to a method, device, equipment and medium for generating OAS Schema.

Background technique

With the development of science and technology in modern society, computer systems have become indispensable tools in all walks of life, and computer software systems play a core role in them. As software systems increasingly penetrate into all walks of life, they become increasingly larger and their own problems become more and more serious. Today's applications are often completed by dozens of people writing hundreds of thousands to millions of lines of code. On the other hand, applications survive and develop in an ever-changing dynamic environment. Therefore, applications require constant maintenance—that is, partial rewriting of parts of the application or new features.

In the field of software development, as the scale of applications continues to expand, the integration and interaction between various parts become more and more complex and demanding. RESTful (English: Representational State Transfer, REST for short, REST refers to a set of architectural constraints and principles. Applications or designs that meet these constraints and principles are RESTful) due to its unique platform-independent, programming language-independent, and clear structure , easy to understand, easy to expand and other features, are being used by more and more manufacturers. Among them, OpenAPI Specification (OAS, interface definition specification). Also known as the Swagger specification, it is a standard specification for describing and defining RESTful web services. It provides a unified way to describe the structure, operation and interaction of APIs (Application Programming Interfaces), allowing developers, API providers and consumers to better understand and use APIs.

OAS Schema (OAS data model) is widely used in OAS to describe the data model of resources, request parameters and response bodies. Through OAS Schema, you can define resource attributes, data types, validation rules, etc. to ensure API request and response data. accuracy and consistency. However, the existing OAS Schema is written manually, which takes a lot of time and effort, and is prone to errors and inconsistencies with the domain model, resulting in the need for multiple modifications and maintenance, which reduces software development efficiency.

Contents of the invention

Embodiments of the present application provide an OAS Schema generation method, device, equipment, and medium, which can solve the existing problems that manual writing of OAS Schema takes a long time, consumes a lot of energy, and is prone to errors and deviations. In order to achieve this goal, the embodiments of this application provide the following solutions.

According to one aspect of the embodiment of the present application, a method for generating OAS Schema is provided, which method includes:

Parse the class diagram file, and obtain class-related information from the parsed file, where the information includes a list corresponding to each class, attributes of the class, and relationship information between classes;

Generate a data model of the OAS based on the class-related information.

In a possible implementation, the class diagram file is parsed and class-related information is obtained from the parsed file, including:

Call a preset parsing object to parse the class diagram file to obtain a target file that can process the data structure. The parsing object includes a parser or library corresponding to the class diagram file;

Extract class-related information from the object file.

In a possible implementation, generating an OAS data model based on the class-related information includes:

Based on the information related to the class, call the preset OAS automatic generation program to generate a data model. The data model includes multiple Schema objects corresponding to the class one-to-one;

Determine the first information of each Schema object in the data model based on the class-related information; the first information includes text information of class name, type and attribute list;

The second information of each Schema object in the data model is determined based on the class-related information. The second information includes the attribute name, data type, attribute constraints of the class, and the relationship between the Schema objects corresponding to each type. Text information corresponding to the reference relationship.

In a possible implementation, determining the first information of each Schema object in the data model based on the class-related information includes:

The name, type and attribute list of the class are defined in the text information of the Schema object according to the class-related information.

In a possible implementation, determining the second information of each Schema object in the data model based on the class-related information includes:

Determine the attribute name and data type of the class in the corresponding Schema object according to the attribute name, and process the constraints of the attributes in the Schema object;

Determine the reference relationship between the Schema objects based on the relationship information.

In a possible implementation, generating an OAS data model based on the class-related information includes:

Generate a corresponding definition file for each Schema object in the data model, and save the definition file and the data model;

Or, generate an OAS file according to each Schema object in the data model, and the OAS file includes the definition corresponding to each Schema object.

In a possible implementation, the method further includes:

Detect whether the class diagram file has changed, and the changes include at least one of adding, deleting, and modifying classes in the class diagram file;

If it is determined that the class diagram file has changed, parse the class diagram file to obtain class-related information, update the generated data model according to the class-related information or generate a new data model for the newly added class, and Synchronously update the generated OAS files.

This application provides a device for generating OAS Schema. The device includes:

The class diagram file parsing module is used to parse the class diagram file, and obtain the class-related information from the parsed file. The information includes the list corresponding to each class, the attributes of the class, and the relationships between classes. relationship information;

A data model generation module is used to traverse the class-related information to generate a data model of the OAS.

The present application provides an electronic device, including a memory, a processor, and a computer program stored on the memory, wherein the processor executes the computer program to implement the steps of the above method.

According to yet another aspect of the embodiments of the present application, a computer-readable storage medium is provided, on which a computer program is stored, and when the computer program is executed by a processor, the steps of the above method are implemented.

The beneficial effects brought by the technical solutions provided by the embodiments of this application are:

The OAS Schema generation method provided by this application parses the class diagram file, obtains class-related information from the parsed file, and generates OAS Schema based on the list corresponding to each class in the information, the attributes of the class, and the relationship between classes. . The embodiment of this application parses the class diagram file and generates OAS Schema based on the parsing results. Therefore, the embodiment of the present application uses class diagram files to automatically generate OAS Schema, reducing the workload of manual writing and maintenance, shortening the time, improving development efficiency, and enabling rapid iteration and modification, reducing the possibility of inconsistency between the OAS Schema and the domain model.

Description of the drawings

In order to explain the technical solutions in the embodiments of the present application more clearly, the drawings needed to be used in the description of the embodiments of the present application will be briefly introduced below.

Figure 1 is a flow chart of the OAS Schema generation method provided by the embodiment of the present application;

Figure 2 is a flow chart of another embodiment of the OAS Schema generation method provided by this application;

Figure 3 is a sequence diagram of an embodiment of the OAS Schema generation method of this application;

Figure 4 is a schematic diagram of a class diagram file used to generate OAS Schema provided by an embodiment of the present application;

Figure 5 is a structural diagram of an OAS Schema generation device provided by an embodiment of the present application;

Figure 6 is a structural diagram of an electronic device provided by an embodiment of the present application.

Detailed ways

The embodiments of the present application are described below with reference to the drawings in the present application. It should be understood that the embodiments described below in conjunction with the accompanying drawings are exemplary descriptions for explaining the technical solutions of the embodiments of the present application, and do not limit the technical solutions of the embodiments of the present application.

Those skilled in the art will understand that, unless expressly stated otherwise, the singular forms "a", "an", "the" and "the" used herein may also include the plural form. It should be further understood that the terms "comprising" and "including" used in the embodiments of this application mean that the corresponding features can be implemented as the presented features, information, data, steps, operations, elements and/or components, but do not exclude Implementation is other features, information, data, steps, operations, elements, components and/or their combinations supported by the technical field. It should be understood that when we refer to an element being "connected" or "coupled" to another element, it can be directly connected or coupled to the other element, or one element and the other element may be connected to the other element through intervening elements. Establish connections. Additionally, "connected" or "coupled" as used herein may include wireless connections or wireless couplings. The term "and/or" as used herein indicates at least one of the items defined by the term, for example, "A and/or B" indicates implemented as "A", or implemented as "A", or implemented as "A and B" ".

In order to make the purpose, technical solutions and advantages of the present invention clearer, the embodiments of the present invention will be described in further detail below with reference to the accompanying drawings.

The following describes the technical solutions of the embodiments of the present invention and the technical effects produced by the technical solutions of the present invention through the description of several exemplary embodiments. It should be noted that the following embodiments can be referred to, borrowed from, or combined with each other. The same terms, similar features, and similar implementation steps in different embodiments will not be repeatedly described.

Based on JSON or YAML format, OAS provides a set of structured specifications and conventions for defining various aspects of the API, including resources, paths, operations, parameters, responses, and security. Its main goal is to make API documentation easy to understand and readable, and to provide an interactive way to test and call APIs.

Schema is widely used in OAS to describe the data model of resources, request parameters and response bodies. Schema can be used to define resource attributes, data types, validation rules, etc. to ensure the accuracy and consistency of API request and response data.

In software development, writing the OAS data model (Schema) is an important task. In the existing solution, the data model is written manually. However, there are the following problems in manually writing the data model.

1. Errors and omissions: Manually writing data models is prone to errors and omissions. Human errors are prone to errors, which may result in incorrectly named properties, wrong data types, or missing necessary fields. These errors may cause the API to not be interpreted or implemented correctly.

2. Inconsistency: In large projects or teams, there are consistency challenges in manually writing Schemas. Different developers may have different writing styles and standards, resulting in inconsistent format and structure of the Schema. This makes maintenance and modification difficult, and increases the difficulty of understanding and collaboration.

3. Time-consuming and labor-intensive: Manually writing Schema is a time-consuming task. Schema may contain a large number of fields and complex data types, and manual writing requires a lot of time and effort. In addition, when the domain model changes, manually updating and adjusting the Schema also requires additional time and effort.

4. Lack of reliability and scalability: Manually written Schema lacks automation and reliability. Manually written Schema is difficult to automatically verify and check, which may result in potential errors and problems not being discovered in time. In addition, when the domain model needs to be extended and updated, the manually written Schema is difficult to automatically adapt to changes and may require a large number of modifications and adjustments.

5. Difficulty in domain model synchronization: There may be difficulties in synchronization between the manually written Schema and the actual domain model. If the domain model changes, the Schema, API, and domain model need to be manually updated to maintain consistency, which requires additional work and management. This can lead to inconsistencies between the API documentation and the actual domain model, causing confusion for users and developers.

The OAS Schema generation method, device, equipment and storage medium provided by this application are intended to solve at least one technical problem existing in the existing technology.

Embodiments of this application provide a method for generating OAS Schema. Devices applying this method can be mobile phones, computers, servers, cloud platforms, and other devices that can be used for data model generation. As shown in Figure 1, the generation method of the OASSchema (hereinafter referred to as the data model) includes steps S101-S102.

S101: Parse the class diagram file and obtain class-related information from the parsed file.

Optionally, the class diagram file can be a PlantUML class diagram file, or it can be a sequence diagram, use case diagram, activity diagram, or other files based on PlantUML technology for describing class information. Among them, PlantUML is an open source drawing tool that allows users to use simple text descriptions to generate various types of diagrams, such as class diagrams, sequence diagrams, use case diagrams, activity diagrams, etc. It uses a text-based markup language to make the chart creation process easier and maintainable.

Optionally, before parsing the class diagram file, the device executing the generation method can determine the class diagram file that needs to be parsed according to the input file selection instruction, or can open a tool for generating the data model according to the input instruction, and input the data into the tool. The class diagram file is determined to be the class diagram file that needs to be parsed. The class diagram file can also be obtained based on information identifying the location of the class diagram file, such as a query operation using the object or an input URL.

Optionally, after obtaining the class diagram file, call a preset parsing object (some parsing tool) to parse the class diagram file, where the parsing object is a parser or library.

In one embodiment, the parsing object includes at least one of PlantUML Parser, Puml2Json, and PlantUML ClassDiagram Parser.

Optionally, the class-related information may include a list corresponding to each class, attributes of the class, and relationship information between classes. The list may include class names, types and other class-related information. Moreover, in order to facilitate subsequent processing, the class diagram file is parsed into a target file that is a processable data structure through a preset parsing structure.

In one embodiment, the processable data structure may be a tree structure or JSON format, and the data structure includes a list of class names, attributes of the class, and relationship information of the class. The relationship information includes relationship information between classes, such as one-to-many relationship, one-to-one relationship, inheritance relationship, etc.

In one example, the relationship information is as follows:

Person "1" *-->"1..*" Address: personAddress

It includes the following:

Main class name: Person

Associated class name: Address

Relationship name between classes: personAddress

Association quantity limit rules: A person can contain 1 to multiple addresses, and an address can only belong to one person.

S102: Traverse the class-related information to generate the OAS data model.

Optionally, traverse the class-related information to generate an OAS data model, including: calling a preset OAS automatic generation program based on the class-related information to generate a data model. The data model includes multiple Schemas corresponding to the class one-to-one. Objects (the number of classes and Schema objects is the same); determine the first information of each Schema object in the data model based on the information related to the class; the first information includes text information corresponding to the class name, type and attribute list; based on the class-related information The information determines the second information of each Schema object in the data model. The second information includes the attribute name of the data model, the data type, the constraints of the attributes in the data model, and the text information corresponding to the reference relationship between various corresponding Schema objects.

In one embodiment, a corresponding data model (ie, OAS Schema) is created based on class-related information. The data Schema object includes multiple Schema objects, and the class-related information is used to define the name of the class in each Schema object. , type (object) and attributes. After completing the definition, obtain the attribute name of the class, map this type of information to the Schema object of the data model, and determine the attribute name of the Schema object (such as determining the data type supported by the data model based on the attribute name of the class, such as string, numbers, Boolean values, etc.). And according to the information related to the class, the constraints of the attributes, such as maximum length, enumeration value, etc., are correspondingly processed, and the reference relationship between Schema objects is set accordingly according to the relationship information in the parsing result.

The embodiment of this application uses class diagram files to automatically generate OAS Schema, which reduces the workload of manual writing and maintenance, shortens the time consumption, improves development efficiency, and enables rapid iteration and modification, reducing the possibility of inconsistency between the OAS Schema and the domain model.

Optionally, this application also proposes a method for generating OAS Schema, as shown in Figures 2-4. The method includes:

S201: Call the preset parsing object to parse the class diagram file and obtain a target file that can process the data structure.

Optionally, use an object to input a class diagram file. The class diagram file is a file related to the data model, including information about each class related to the data model. After the device receives the class diagram file, it calls the preset parsing object to parse the class. Picture file. Wherein, the parsing object includes at least one of PlantUML Parser, Puml2Json, and PlantUML Class Diagram Parser.

Optionally, the device can obtain the name, number, format and other information that can identify the parsing object of the input class diagram file, determine the parsing object corresponding to the class diagram file based on the information, and call the parsing object to perform the parsing operation.

In one embodiment, the class diagram file is a PlantUML class diagram file. The class diagram file is received, and the parsing object corresponding to the class diagram file is called to obtain the parsing result of the class diagram file.

Optionally, the target file as the parsing result uses a processable data structure, which can be set according to actual needs and the type of the parsed object. The processable data structure includes a list of classes, attribute information of the classes, and relationships between classes. information.

In one embodiment, the processable data structure may be any of a tree structure and a JSON format.

S202: Extract class-related information from the target file.

Optionally, extract the list of classes and their attributes and relationship information from the target file. Relationship information includes relationship information between two classes, such as one-to-many relationship, one-to-one relationship, inheritance relationship, etc.

In one embodiment, the relationship information in the extracted class-related information is: Person "1" *-->"1..*"Address: personAddress, and the relationship information includes the following:

Main class name: Person

Associated class name: Address

Relationship name between classes: personAddress

Association quantity limit rules: A person can contain 1 to multiple addresses, and an address can only belong to one person.

Optionally, after using the parsing object to parse the class diagram file to obtain the target file, use an extractor to extract class-related information, and the extractor extracts information according to the data structure of the target file.

S203: Call the preset OAS automatic generation program based on the information related to the class to generate the data model, determine the first information of each Schema object in the data model based on the information related to the class, and determine each Schema in the data model based on the information related to the class. Secondary information about the object.

Optionally, the first information includes the name, type, and text information corresponding to the attribute list of the class, and the second information includes the attribute name, data type, attribute constraints of the data model, and the reference relationship corresponding to the class. Among them, the data model consists of multiple Schema objects, and the final data model is obtained by processing the first information and the second information related to the Schema objects.

Optionally, determining the first information of each Schema object in the data model based on the class-related information includes: defining the name, type, and attribute list of the class in the text information of each Schema object based on the class-related information.

In one embodiment, each class in the target file can be represented as an OAS Schema object. Create a corresponding Schema object based on the extracted information (which can be a list of classes), and generate the text information of the class name, type (object), and attribute list in the Schema object. Specifically, according to the information related to the class, the preset program is called to generate the text content of the corresponding Schema object. The text content includes the name, type (object) and attributes of the class, where the name of the class is used as the name of the Schema object. Among them, the preset program can automatically generate programs for OAS.

Specifically, the definition of a Schema object created based on the class-related information in the above embodiment (the relationship information is set to: Person "1" *-->"1..*" Address: personAddress) is as follows:

components:

schemas:

Person:

type: object This type is currently fixed Object.

properties: Properties refer to the attributes of the class.

ID:

type: string

name:

type: string

Among them, in addition to generating Schema object Person and corresponding text information, Schema object PersonAddress and text information corresponding to PersonAddress are also generated.

In one embodiment, a Schema generator can be used to create class definitions and attributes, and the Schema generator can be used to determine the attribute names of the data model and the constraint relationships of the attributes.

Optionally, determine the second information of each Schema object in the data model based on the information related to the class, including: determining the attribute name and data type of the corresponding Schema object according to the attribute name, and processing the constraints of the attributes; according to the relationship information Determine the reference relationship between Schema objects.

In one embodiment, the attribute names of the classes in the class diagram file are mapped to the corresponding Schema objects to determine the attribute names of the Schema objects. Determine the data types supported by the Schema object based on the attribute name, such as strings, numbers, Boolean values, etc. At the same time, handle constraints on attributes, such as maximum length, enumeration values, etc. Specifically, the attribute name String in the class diagram file corresponds to the created Schema object as string, the attribute name Long in the class diagram file corresponds to the attribute name in the Schema object as string, etc. The attribute names are determined according to the preset mapping relationship. mapping. It can be replaced based on the mapping relationship when using a program (such as the OAS automatic generation program) to generate text related to attributes in the Schema object.

In an example:

The Person in the PlantUML class diagram file looks like this:

class Person<<Resource>>{

{field}id: String

{field}name: String

}

Among them, the attribute name is String, and the attribute name in the Schema object is defined accordingly according to the attribute name:

components:

schemas:

Person:

type: object

properties:

ID:

type: string

name:

type: string

In another example, the attribute name in the class diagram file is: {field}id: String, and the description text corresponding to the attribute name in the Schema object corresponding to this type is:

properties:

ID:

type: string

Optionally, because there may be associations between classes in the class diagram file (such as aggregation, inheritance, association, etc.), references ($ref) can be used in the data model to represent the associations between classes. Based on the relationship information in the class diagram, the corresponding reference relationship is generated and referenced using $ref in the Schema object.

In one embodiment, a Reference Handler (reference handler) is used to obtain relationship information between classes in the class diagram file, and reference relationships between Schema objects are correspondingly generated based on the relationship information.

Optionally, in order to realize the storage call of the data model and the rapid generation of OAS files, traverse the class-related information to generate the OAS data model, including: generating a corresponding definition file for each Schema object in the data model, and saving Definition file and data model; or, generate an OAS file based on each Schema object in the data model. The OAS file includes the definition corresponding to each Schema object.

Optionally, the definition file can be part of the OAS file, or can be saved independently from the OAS file, and the OAS file saves the reference method of the definition file. The definition file includes the definition of the generated Schema object, and the definition includes the definition of an interface for performing operations such as addition, deletion, modification, and query on the Schema object.

In one embodiment, the definition file is part of the OAS file. An example of the OAS file is as follows:

components:

schemas:

Person:

type: object

properties:

ID:

type: string

name:

type: string

In another embodiment, the definition file is saved separately as: Person_schemas.yaml:. The relevant OAS file is: Person_Management-v1.0.0.oas.yaml. The OAS file also includes the reference method of the definition file:

CuPerson:

type: object

properties:

ID:

type: string

name:

type: string

Then reference it in Person_Management-v1.0.0.oas.yaml:

paths:

/persons:

get:

summary: Get all persons

responses:

'200':

description: A list of persons

content:

application/json:

Schema:

type: array

items:

$ref: 'Person_schemas.yaml#/Person'

Optionally, when saving the definition file, if the definition of the Schema object is written to the OAS file, you only need to save the OAS file. If the Schema object of the data model is saved separately, the corresponding definition file needs to be saved at the same time. If each Schema object If saved separately, there will be as many definition files as there are Schema objects.

Optionally, in order to achieve rapid iteration of the data model, detect whether the class diagram file has changed. The changes include at least one of adding, deleting, and modifying classes in the class diagram file; if it is determined that the class diagram file has changed, parse the class diagram file. The graph file obtains class-related information and generates a new data model based on the class-related information.

The OAS Schema generation method of this application will be further described below in conjunction with Figure 3.

As shown in Figure 3, users provide PlantUML class diagram files as files for generating data models through user terminals (such as mobile phones and computers). After receiving the class diagram file, use the preset parsing object to parse the PlantUML class diagram file and generate a target file whose structure is a processable data structure. Extract class names, attributes, and relationship information from the target file according to the data structure. Generate a Schema object of the data model based on the extracted information, create class definitions, attribute names, and data types in the Schema object, process attribute constraints, and set reference relationships between Schema objects. After the Schema object of the data model is created, the generated data model is returned to the user and the OAS file or definition file corresponding to the data model is saved.

In one embodiment, the PlantUML class diagram file is shown in Figure 4. An example of the data model generated based on the class diagram file is:

addresses:

type: array

items:

$ref: '#/components/schemas/Address'

This data model well reflects the relationship in the PlantUML class diagram that a person can contain 1 to multiple addresses.

An OpenAPI example that includes this data model is as follows:

openapi: 3.0.0

info:

title: Example API

version: 1.0.0

paths:

/persons:

get:

summary: Get all persons

responses:

'200':

description: Successful response

content:

application/json:

Schema:

type: array

items:

$ref: '#/components/schemas/Person'

components:

schemas:

Person:

type: object

properties:

ID:

type: string

name:

type: string

addresses:

type: array

items:

$ref: '#/components/schemas/Address'

required:

-id

- name

Address:

type: object

properties:

street:

type: string

city:

type: string

country:

type: string

required:

- street

-city

-country

This OpenAPI example defines the API interface related to the resource person. The example interface /persons obtains the list of all Persons, and the returned content is the list of Persons. The definition of Person refers to the definition of Person Schema, which is specified in '#/components/ of this file. schemas/Person' section.

In the schemas part of components, the schema of the object Person is defined, and the schema of the Address and the relationship object between Person and Address are also defined. These schemas define the object's type, name, and attribute list. For each attribute, the name and type are defined.

The schema of each object defined in the schemas of components is what this application automatically generates based on the PlantUML class diagram.

Different from the previous method of generating Schema objects separately and referencing them, Person Schema also contains a reference to another data model, Address Schema.

This example shows the query interface (API) for obtaining Person Schema objects. Through this API, you can query and obtain a list of all person objects, where the structure of each person object is defined by Person Schema.

Compared with the existing technology, the OAS Schema generation method of this application has the following advantages:

1. Improve development efficiency: By automatically generating OAS Schema, the workload of manual writing and maintenance is reduced, and development efficiency is improved.

2. Ensure consistency: The automatically generated OAS Schema is consistent with the domain model, avoiding inconsistencies that may occur when writing manually.

3. Rapid iteration and modification: Since OAS Schema is generated based on PlantUML class diagram files, iteration and modification can be easily carried out, speeding up the development process.

4. Improve accuracy: The automatically generated OAS Schema method can avoid errors that may occur during manual writing and improve the accuracy of the data model.

It should be noted that in the optional embodiments of the present application, the data involved (such as class diagram files, data models, OAS Schema and other data), when the above embodiments of the present application are applied to specific products or technologies, It is necessary to obtain the permission or consent of the user, and the collection, use and processing of relevant data need to comply with the relevant laws, regulations and standards of the relevant countries and regions. That is to say, if the embodiments of this application involve data related to objects, these data need to be obtained with the authorization and consent of the objects and in compliance with relevant laws, regulations and standards of the country and region.

According to one aspect of the present application, the present application provides an OAS Schema generation device. As shown in Figure 5, the OAS Schema generation device 300 includes a class diagram file parsing module 310 and a data model generation module 320, wherein the class diagram file parsing module 310, used to parse the class diagram file and obtain class-related information from the parsed file. The information includes a list corresponding to each class, attributes of the class, and relationship information between classes; data model generation module 320, Data model used to generate OAS based on class-related information.

Optionally, parse the class diagram file and obtain class-related information from the parsed file, including: calling a preset parsing object to parse the class diagram file to obtain a target file that can process the data structure. The parsing object includes the class diagram. The parser or library corresponding to the file;

Extract class-related information from the target file. Class-related information includes class name, class attributes, and class relationship information.

Optionally, traverse class-related information to generate an OAS data model, including:

Based on the information related to the class, the preset OAS automatic generation program is called to generate a data model. The data model includes multiple Schema objects corresponding to the class one-to-one;

Determine the first information of each Schema object in the data model based on the information related to the class; the first information includes text information of class name, type and attribute list;

The second information of each Schema object in the data model is determined based on the class-related information. The second information includes the attribute name, data type, attribute constraints of the data model, and the text corresponding to the reference relationship between various corresponding Schema objects. information.

Optionally, determine the first information of each Schema object in the data model based on class-related information, including:

The name, type and attribute list of the class are defined in the text information of the Schema object according to the information related to the class.

Optionally, determining the second information of each Schema object in the data model based on the information related to the class includes: determining the attribute name and data type of the class in the corresponding Schema object based on the attribute name, and performing constraints on the attributes in the Schema object. Processing; determine the reference relationship between Schema objects based on the relationship information.

Optionally, traverse class-related information to generate an OAS data model, including:

Generate a corresponding definition file for each Schema object in the data model, and save the definition file and data model;

Or, generate an OAS file according to each Schema object in the data model, and the OAS file includes the definition corresponding to each Schema object.

Optionally, the method also includes: detecting whether the class diagram file has changed, and the changes include at least one of adding, deleting, and modifying classes in the class diagram file;

If it is determined that the class diagram file has changed, parse the class diagram file to obtain class-related information, update the generated data model based on the class-related information or generate a new data model for the newly added class, and synchronously update the generated data model. OAS file.

In an optional embodiment, an electronic device is provided, as shown in Figure 6. The electronic device 4000 shown in Figure 6 includes: a processor 4001 and a memory 4003. Among them, the processor 4001 and the memory 4003 are connected, such as through a bus 4002. Optionally, the electronic device 4000 may also include a transceiver 4004, which may be used for data interaction between the electronic device and other electronic devices, such as data transmission and/or data reception. It should be noted that in practical applications, the number of transceivers 4004 is not limited to one, and the structure of the electronic device 4000 does not constitute a limitation on the embodiments of the present application.

The processor 4001 can be a CPU (Central Processing Unit, central processing unit), a general-purpose processor, a DSP (Digital Signal Processor, a data signal processor), an ASIC (Application Specific Integrated Circuit, an application specific integrated circuit), an FPGA (Field Programmable Gate Array, a field programmable gate array) or other programmable gate arrays. Programmed logic devices, transistor logic devices, hardware components, or any combination thereof. It may implement or execute the various illustrative logical blocks, modules, and circuits described in connection with this disclosure. The processor 4001 may also be a combination that implements computing functions, such as a combination of one or more microprocessors, a combination of a DSP and a microprocessor, etc.

Bus 4002 may include a path that carries information between the above-mentioned components. The bus 4002 may be a PCI (Peripheral Component Interconnect, Peripheral Component Interconnect Standard) bus or an EISA (Extended Industry Standard Architecture) bus, etc. The bus 4002 can be divided into an address bus, a data bus, a control bus, etc. For ease of presentation, only one thick line is used in the figure, but it does not mean that there is only one bus or one type of bus.

The memory 4003 may be ROM (ReadOnlyMemory, read-only memory) or other types of static storage devices that can store static information and instructions, RAM (RandomAccessMemory, random access memory) or other types of dynamic storage devices that can store information and instructions, It can also be EEPROM (Electrically Erasable Programmable ReadOnly Memory), CD-ROM (CompactDiscReadOnlyMemory, read-only disc) or other optical disc storage, optical disc storage (including compressed optical discs, laser discs, optical discs, digital versatile discs, Blu-ray discs etc.), disk storage media, other magnetic storage devices or any other media that can be used to carry or store computer programs and can be read by a computer, without limitation here.

The memory 4003 is used to store computer programs for executing embodiments of the present application, and is controlled by the processor 4001 for execution. The processor 4001 is used to execute the computer program stored in the memory 4003 to implement the steps shown in the foregoing method embodiments.

Among them, the electronic device can be any electronic product that can perform human-computer interaction with the object, such as a personal computer, a tablet computer, a smart phone, a personal digital assistant (Personal Digital Assistant, PDA), a game console, an interactive network television (Internet Protocol Television, IPTV), smart wearable devices, etc.

The electronic device may also include a network device and/or an object device. The network device includes, but is not limited to, a single network server, a server group composed of multiple network servers, or a cloud composed of a large number of hosts or network servers based on cloud computing (Cloud Computing).

The network where the electronic device is located includes but is not limited to the Internet, wide area network, metropolitan area network, local area network, virtual private network (Virtual Private Network, VPN), etc.

Embodiments of the present application provide a computer-readable storage medium. A computer program is stored on the computer-readable storage medium. When the computer program is executed by a processor, the steps and corresponding contents of the foregoing method embodiments can be implemented.

The terms "first", "second", "third", "fourth", "1", "2", etc. (if present) in the description and claims of this application and the above-mentioned drawings are used for Distinguishes similar objects without necessarily describing a specific order or sequence. It is to be understood that the data so used are interchangeable under appropriate circumstances so that the embodiments of the application described herein can be practiced in other than the order illustrated or described.

It should be understood that although each operation step is indicated by arrows in the flow chart of the embodiment of the present application, the order of implementation of these steps is not limited to the order indicated by the arrows. Unless otherwise specified herein, in some implementation scenarios of the embodiments of the present application, the implementation steps in each flowchart may be executed in other orders according to requirements. In addition, some or all of the steps in each flowchart are based on actual implementation scenarios and may include multiple sub-steps or multiple stages. Some or all of these sub-steps or stages may be executed at the same time, and each of these sub-steps or stages may also be executed at different times. In scenarios with different execution times, the execution order of these sub-steps or stages can be flexibly configured according to needs, and the embodiments of the present application do not limit this.

The above are only optional implementation modes of some implementation scenarios of the present application. It should be pointed out that for those of ordinary skill in the technical field, without departing from the technical concept of the solution of the present application, adopting solutions based on the technical ideas of the present application Other similar implementation means also fall within the protection scope of the embodiments of this application.

Claims (10)

1. A method for generating OAS Schema, which is characterized by including: Parse the class diagram file, and obtain class-related information from the parsed file, where the information includes a list corresponding to each class, attributes of the class, and relationship information between classes; Traverse the class-related information to generate a data model of the OAS. 2. The method according to claim 1, characterized in that said parsing a class diagram file and obtaining class-related information from the parsed file includes: Call a preset parsing object to parse the class diagram file to obtain a target file that can process the data structure. The parsing object includes a parser or library corresponding to the class diagram file; Extract class-related information from the object file. 3. The method according to claim 2, characterized in that said traversing the class-related information to generate a data model of OAS includes: Based on the information related to the class, call the preset OAS automatic generation program to generate a data model. The data model includes multiple Schema objects corresponding to the class one-to-one; Determine the first information of each Schema object in the data model based on the class-related information; the first information includes text information of class name, type and attribute list; The second information of each Schema object in the data model is determined based on the class-related information. The second information includes the attribute name, data type, attribute constraints of the class, and the relationship between the Schema objects corresponding to each type. Text information corresponding to the reference relationship. 4. The method of claim 3, wherein determining the first information of each Schema object in the data model based on the class-related information includes: The name, type and attribute list of the class are defined in the text information of the Schema object according to the class-related information. 5. The method of claim 3, wherein determining the second information of each Schema object in the data model based on the class-related information includes: Determine the attribute name and data type of the class in the corresponding Schema object according to the attribute name, and process the constraints of the attributes in the Schema object; Determine the reference relationship between the Schema objects based on the relationship information. 6. The method according to claim 3, characterized in that said traversing the class-related information to generate a data model of OAS includes: Generate a corresponding definition file for each Schema object in the data model, and save the definition file and the data model; Or, generate an OAS file according to each Schema object in the data model, and the OAS file includes the definition corresponding to each Schema object. 7. The method according to claim 6, characterized in that the method further includes: Detect whether the class diagram file has changed, and the changes include at least one of adding, deleting, and modifying classes in the class diagram file; If it is determined that the class diagram file has changed, parse the class diagram file to obtain class-related information, update the generated data model according to the class-related information or generate a new data model for the newly added class, and Synchronously update the generated OAS files. 8. A device for generating OAS Schema, characterized in that the device includes: The class diagram file parsing module is used to parse the class diagram file and obtain class-related information from the parsed file. The information includes lists corresponding to each class, attributes of the class, and relationship information between classes; A data model generation module is used to traverse the class-related information to generate a data model of the OAS. 9. An electronic device, comprising a memory, a processor and a computer program stored on the memory, characterized in that the processor executes the computer program to implement the steps of the method according to any one of claims 1-7 . 10. A computer-readable storage medium with a computer program stored thereon, characterized in that when the computer program is executed by a processor, the steps of the method according to any one of claims 1-7 are implemented.