Looking for breakthrough ideas for innovation challenges? Try Patsnap Eureka!

API document generating method and system based on SpringMVC

A document generation and documentation technology, applied in memory system, parser generation, creation/generation of source code, etc., can solve the problems of untimely update of API documents and high maintenance cost, and achieve easy-to-master, fewer annotations, and rapid development. Effect

Inactive Publication Date: 2017-12-26
蓝海天网科技有限公司
View PDF3 Cites 10 Cited by
  • Summary
  • Abstract
  • Description
  • Claims
  • Application Information

AI Technical Summary

Problems solved by technology

The method and system can solve the problems of untimely update of API documents and high maintenance costs, save developers time and cost, and improve work enthusiasm

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
  • API document generating method and system based on SpringMVC
  • API document generating method and system based on SpringMVC

Examples

Experimental program
Comparison scheme
Effect test

Embodiment Construction

[0029] Please refer to figure 1 . Such as figure 1 As shown, the SpringMVC-based API document generation method disclosed in the present invention mainly includes the following steps:

[0030] 10. Mark the API information in the custom data bean, specifically, mark the API information in the custom data bean through the custom annotation, and the custom bean is used for the input and output parameters of the controller layer API method of the server code ;

[0031] 11. Traverse the server-side Controller layer methods, and automatically capture the input and output references of its functions;

[0032] 12. Analyze all the parameters of the input and output parameters, generate API documents, and automatically build the parameter hierarchy structure of the API through the mutual reference and nesting of the parameter objects;

[0033] 13. Send the results obtained by traversal and analysis to the web client, and provide the client with visualized API technical documentation...

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 provides an API document generating method and system based on SpringMVC. Through a self-defined note, API information is marked in self-defined data Bean which is used for parameter output and input of a function of a Controller layer of a server side code, the parameter output and input introduction of the function is automatically captured through a method of traversing the code Controller layer running on a server side, all parameters of the parameter output and input are analyzed, an API document is generated, through the mutual introduction and nesting of parameter objects, a parameter hierarchical structure of API is automatically established, then the result obtained through traversing and analyzing is issued to a Web client side, and a visual API technological document is provided for front-end developers. The problems that the API document is not timely in updating and maintenance cost is high can be solved, the time cost is saved for the developers, and the working enthusiasm is improved.

Description

technical field [0001] The invention relates to application program development, in particular to a method and system for generating API documents based on SpringMVC. Background technique [0002] At present, a large number of Web App developments in the Internet use JavaEE technology, and a large number of SpringMVC back-end frameworks are used. [0003] During development, the API document is an indispensable technical document for the front-end and back-end docking interfaces and debugging interfaces. Of course, the API documentation is independent of the running code, and can be manually written or generated by a series of API documentation generation frameworks provided on the Internet. No matter which method is adopted, the accuracy and timeliness of API documentation greatly affect the development efficiency and enthusiasm of front-end and back-end developers, so a highly automated API documentation framework is of great significance and role. [0004] If the API in...

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): G06F9/45
CPCG06F8/37G06F8/427
Inventor 王思望
Owner 蓝海天网科技有限公司
Who we serve
  • R&D Engineer
  • R&D Manager
  • IP Professional
Why Patsnap Eureka
  • Industry Leading Data Capabilities
  • Powerful AI technology
  • Patent DNA Extraction
Social media
Patsnap Eureka Blog
Learn More
PatSnap group products

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

© 2024 PatSnap. All rights reserved.Legal|Privacy policy|Modern Slavery Act Transparency Statement|Sitemap|About US| Contact US: help@patsnap.com