Method and device for generating interface document

An interface and documentation technology, applied in the computer field, can solve the problems of difficult maintenance of API documentation, generation, and lack of documentation, etc., and achieve the effect of solving the difficulty of writing and maintenance

Active Publication Date: 2015-09-30
BEIJING DIDI INFINITY TECH & DEV
View PDF5 Cites 7 Cited by
  • Summary
  • Abstract
  • Description
  • Claims
  • Application Information

AI Technical Summary

Problems solved by technology

But for now, more companies often do not have a unified and strict writing specification at the beginning stage, and there is no way to automatically generate documents
Even if the specification is strictly implemented in the future, it will be a lot of work to sort out the previous output interface, and the subsequent modification and maintenance of the code also needs to be able to maintain the update of the generated document part in real time, otherwise the actual implementation of the interface will be different from the document description. inconsistent
In short, maintaining API documentation is not an easy job

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 generating interface document
  • Method and device for generating interface document
  • Method and device for generating interface document

Examples

Experimental program
Comparison scheme
Effect test

Embodiment Construction

[0022] The principle and spirit of the embodiments of the present disclosure will be described below with reference to the accompanying drawings. It should be understood that these embodiments are described only to enable those skilled in the art to better understand and implement the present disclosure, but not to limit the scope of the present disclosure in any way.

[0023] figure 1 A flowchart of a method 100 for generating an interface document according to an embodiment of the present disclosure is schematically shown. Generally speaking, the method 100 can be used to automatically generate an interface document, and at the same time realize the function of the client accessing the server. In some embodiments, the method 100 may be performed by an apparatus, a tool, or any other suitable entity for generating an interface document according to an embodiment of the present invention.

[0024] Such as figure 1 As shown in , the method 100 proceeds to step 101 after bein...

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

An embodiment of the invention provides a method and a device for generating an interface document. The method includes the steps: analyzing a domain name in an incoming message from a client; judging whether the domain name is placed in a preconfigured domain name list or not; responding to the domain name in the domain name list and acquiring interface information related to the domain name; generating the interface document based on the interface information.

Description

technical field [0001] Embodiments of the present disclosure generally relate to the technical field of computers, and particularly relate to a method and device for generating an interface document. Background technique [0002] At present, the servers of Internet companies often open a lot of interfaces to clients, but there are often very few documents for such interfaces within the company, which increases the cost of internal learning and communication. Writing such documentation is either manual or generated from code. For some products that strictly abide by the code writing rules from the beginning, the information in the code can be extracted through tools to generate interface documents. But for now, more companies often do not have a unified and strict writing standard at the beginning stage, and there is no way to automatically generate documents. Even if the specification is strictly implemented in the future, it will be a lot of work to sort out the previous ...

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): H04L29/06H04L29/08
CPCH04L63/0236H04L67/02H04L67/146H04L61/4511H04L67/561H04L67/5682
Inventor 肖德超
Owner BEIJING DIDI INFINITY TECH & DEV
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