Method and device for automatically generating description document of API (application program interface)

A technology of API interface and description document, which is applied in the computer field, can solve problems such as paying extra labor costs, not updating in time, and using API interfaces incorrectly, so as to achieve the effect of saving labor costs and facilitating synchronization of updates

Active Publication Date: 2013-04-17
MICRO DREAM TECHTRONIC NETWORK TECH CHINACO
View PDF4 Cites 48 Cited by
  • Summary
  • Abstract
  • Description
  • Claims
  • Application Information

AI Technical Summary

Problems solved by technology

[0004] However, at present, the description documents of API interfaces are generally maintained manually, that is, programmers or related technicians who are familiar with API interface functions record the functions, parameters and other information of the API interface in the description documents; this makes the description documents of API interfaces The update of the API must be manually intervened, and additional labor costs are required to manage the description document; more seriously, if the description document is not updated in time after the API interface is updated due to personnel negligence or other reasons, it may cause third-party The caller incorrectly uses the API interface

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
  • Method and device for automatically generating description document of API (application program interface)
  • Method and device for automatically generating description document of API (application program interface)
  • Method and device for automatically generating description document of API (application program interface)

Examples

Experimental program
Comparison scheme
Effect test

Embodiment Construction

[0043]In order to make the object, technical solution and advantages of the present invention clearer, the present invention will be described in further detail below with reference to the accompanying drawings and preferred embodiments. However, it should be noted that many of the details listed in the specification are only for readers to have a thorough understanding of one or more aspects of the present invention, and these aspects of the present invention can be implemented even without these specific details.

[0044] As used herein, terms such as "module" and "system" are intended to include computer-related entities such as, but not limited to, hardware, firmware, a combination of hardware and software, software, or software in execution. For example, a module may be, but is not limited to being limited to being, a process running on a processor, a processor, an object, an executable, a thread of execution, a program, and / or a computer. For example, both an application...

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 discloses a method and a device for automatically generating a description document of an API (application program interface). The method includes generating a reflection object of a method function having a mapping relation to the API; acquiring annotation information of the method function contained in the reflection object; and generating the description document of the API as preset format according to the acquired annotation information. By generating the reflection object of the method function by means of a reflection mechanism and acquiring the annotation information, which generally contains function description and parameter description of the method function, of the method function from the reflection object, the description document in preset format can be automatically generated according to the annotation information, and accordingly, the description document of the API related to the method function is automatically generated, labor cost is saved, and synchronization in updating the description document and the API is more convenient.

Description

technical field [0001] The invention relates to computer technology, in particular to a method and a device for automatically generating a description document of an API interface. Background technique [0002] Many social networking sites today provide an open API (Application Program Interface) interface for third-party clients or websites to call to achieve the purpose of quickly sharing information, increasing user stickiness, and opening up new profit models. Among the API interfaces provided by these websites, there are many WEB (network) service solutions provided by the REST (Representational State Transfer) architecture. Since REST-style WEB services are built on the HTTP (Hyper Text Transport Protocol, Hypertext Transfer Protocol) protocol, compared with SOAP (Simple Object Access Protocol, Simple Object Access Protocol) and XML-RPC, it is lightweight, simple, and Elegant, efficient and other characteristics, so it is favored by the open platform of many social ne...

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/44G06F17/30
Inventor 张威
Owner MICRO DREAM TECHTRONIC NETWORK TECH CHINACO
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