Application programming interface document generation method and device and terminal equipment

An application program and programming interface technology, applied in the field of application programming interface document generation, can solve problems such as code intrusion, and achieve the effect of avoiding code intrusion

Pending Publication Date: 2019-08-23
PING AN TECH (SHENZHEN) CO LTD
View PDF10 Cites 27 Cited by
  • Summary
  • Abstract
  • Description
  • Claims
  • Application Information

AI Technical Summary

Problems solved by technology

[0004] In view of this, the embodiment of the present invention provides a method, device, and terminal device for generating API documents to solve the technical problem in the prior art that the code is too intrusive in the process of generating API documents

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
  • Application programming interface document generation method and device and terminal equipment
  • Application programming interface document generation method and device and terminal equipment
  • Application programming interface document generation method and device and terminal equipment

Examples

Experimental program
Comparison scheme
Effect test

Embodiment Construction

[0038] In the following description, specific details such as specific system structures and technologies are presented for the purpose of illustration rather than limitation, so as to thoroughly understand the embodiments of the present invention. It will be apparent, however, to one skilled in the art that the invention may be practiced in other embodiments without these specific details. In other instances, detailed descriptions of well-known systems, devices, circuits, and methods are omitted so as not to obscure the description of the present invention with unnecessary detail.

[0039] In addition, if the description of "first" or "second" in the present invention is used for description purposes only, it should not be understood as indicating or implying their relative importance or implicitly indicating the quantity of indicated technical features. Thus, a feature defined as "first" or "second" etc. may explicitly or implicitly include at least one of that feature.

[...

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 is applicable to the technical field of software development, and provides an application programming interface document generation method and device and terminal equipment, and the method comprises the steps: obtaining a source code of an application; wherein the source code comprises interface information and annotation information of a plurality of APIs called by the application program; analyzing the source code, and extracting interface information of a target API of the API document to be generated; extracting annotation information of the target API from the source code; associating the interface information of the target API with the annotation information; and generating an API document of the target API according to the associated interface information and annotation information. The invention provides an API document generation method capable of avoiding code invasion.

Description

technical field [0001] The invention belongs to the technical field of software development, and in particular relates to a method, device and terminal equipment for generating an application programming interface document. Background technique [0002] In the Internet software system, the front end and the back end of the application program realize logical interaction and data exchange through an application programming interface (Application Programming Interface, API). Therefore, providing front-end developers with accurate API documents quickly helps to improve the collaboration efficiency of front-end developers and back-end developers. [0003] At present, there are already some tools or frameworks for automatically generating API documents, and the Swagger framework is a typical representative of them and is widely used. However, using the Swagger framework to generate API documents has some shortcomings: First, the code is too intrusive, and a large number of annot...

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/30G06F8/41
CPCG06F8/37G06F8/427
Inventor 薛雷
Owner PING AN TECH (SHENZHEN) CO LTD
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