A diversified interface document generation method

A document generation and interface technology, applied in the field of multi-interface document generation

Inactive Publication Date: 2019-04-26
G CLOUD TECH
View PDF3 Cites 5 Cited by
  • Summary
  • Abstract
  • Description
  • Claims
  • Application Information

AI Technical Summary

Problems solved by technology

[0008] The technical problem solved by the present invention is to provide a method for generating multiple interface documents; to solve the background interface document management problem

Method used

the structure of the environmentally friendly knitted fabric provided by the present invention; figure 2 Flow chart of the yarn wrapping machine for environmentally friendly knitted fabrics and storage devices; image 3 Is the parameter map of the yarn covering machine
View more

Image

Smart Image Click on the blue labels to locate them in the text.
Viewing Examples
Smart Image
  • A diversified interface document generation method
  • A diversified interface document generation method
  • A diversified interface document generation method

Examples

Experimental program
Comparison scheme
Effect test

Embodiment Construction

[0032] See figure 1 Shown, flow process of the present invention is as follows:

[0033] Step 1: Based on SpringMvc, add the @ApiDoc annotation to the head of the interface class to mark that the class needs to be discovered by the scanner.

[0034] Step 2: Add the @ApiOperation annotation to the Api method that needs to be added to the interface document to mark that the method needs to be added to the interface document.

[0035] Step 3: Write the URL address of the interface, the title of the interface document, the permission mark corresponding to the interface, description, specify the input parameter class, output parameter class, and header header class on the @ApiOperation annotation. These attributes can be entered and displayed by the scanner to the interface documentation.

[0036] Step 4: In the project startup method, add the ApiLogUtil calling method to start scanning the classes and methods marked with annotations in the project.

[0037] Step 5: Edit the for...

the structure of the environmentally friendly knitted fabric provided by the present invention; figure 2 Flow chart of the yarn wrapping machine for environmentally friendly knitted fabrics and storage devices; image 3 Is the parameter map of the yarn covering machine
Login to view more

PUM

No PUM Login to view more

Abstract

The invention relates to the technical field of Java server development, in particular to a diversified interface document generation method. The method comprises the following steps: firstly, addingat ApiDoc annotations to the head of a module Controller class; then at ApiOperiton is added to the interface entry method, then an interface address, a name, description, authority, an input parameter class, an output parameter class and a header head class are set, and when a final project is started, all the methods needing to generate the interface document can be automatically scanned, and the customized interface document is generated. According to the invention, the synchronization problem of the interface document along with the code is solved; Developers, testers and operation and maintenance personnel can understand interface documents automatically generated by the system more clearly and more accurately.

Description

technical field [0001] The invention relates to the technical field of Java server development, in particular to a method for generating multiple interface documents. Background technique [0002] Today's application systems are getting larger and larger, and the frequency of system repairs and updates is increasing; the frequency of editing interface documents is also increasing; this will cause the following problems: [0003] One is that the interface document and background code are not synchronized. [0004] The second is that the interface documents are not classified, and it is difficult to consult them. [0005] The third is that multi-layer parameters cannot be displayed. [0006] Fourth, the format of the interface document is single. [0007] In order to save development and testing time, and make it easier for operation and maintenance personnel to manage the interface; a method for generating diversified interface documents is needed, so that it can be develo...

Claims

the structure of the environmentally friendly knitted fabric provided by the present invention; figure 2 Flow chart of the yarn wrapping machine for environmentally friendly knitted fabrics and storage devices; image 3 Is the parameter map of the yarn covering machine
Login to view more

Application Information

Patent Timeline
no application Login to view more
Patent Type & Authority Applications(China)
IPC IPC(8): G06F8/35G06F8/41
CPCG06F8/35G06F8/44
Inventor 张志江季统凯
Owner G CLOUD TECH
Who we serve
  • R&D Engineer
  • R&D Manager
  • IP Professional
Why Eureka
  • Industry Leading Data Capabilities
  • Powerful AI technology
  • Patent DNA Extraction
Social media
Try Eureka
PatSnap group products

Browse by: Latest US Patents, China's latest patents, Technical Efficacy Thesaurus, Application Domain, Technology Topic.

© 2024 PatSnap. All rights reserved.Legal|Privacy policy|Modern Slavery Act Transparency Statement|Sitemap