用于生成接口文档的方法和装置的制造方法_2

文档序号:9238153阅读:来源:国知局
径信息、接口的方法信息、接口的参数名信息、接口的参数描述信息、接口的参数示例信息、或者与接口有关的任何信息。此外,本领域的技术人员可以理解,方法100的执行实体可以采用任何已知的方法来获得与域名有关的各种接口信息,本公开的实施例在这个方面不受限制。
[0028]在另一些实施例中,方法100可以包括:响应于域名不在域名列表中,不获得与该域名有关的接口信息。在这个方面,如果方法100的执行实体在步骤102中判断出域名不在预配置的域名列表中,则方法100的执行实体可以不获得与该域名有关的接口信息。
[0029]接着,方法100前进至步骤104。在步骤104中,基于接口信息来生成接口文档。在一些实施例中,接口文档中可以包括但不限于,接口的路径、接口的方法、接口的参数名、接口的参数描述、接口的参数示例、或者其他与接口有关的项目。在一些实施例中,接口文档可以包括HTML接口文档。在这个方面,HTML接口文档可以包括基于超文本标记语言(HTML)的接口文档。此外,本领域的技术人员可以理解,方法100的执行实体可以采用任何已知的方法基于接口信息来生成接口文档,本公开的实施例在这个方面不受限制。在完成步骤104之后,方法100可以结束。
[0030]在一些实施例中,方法100可以进一步包括:将传入消息转发给服务器,从服务器接收返回消息,并且将返回消息转发给客户端。通过这些步骤,方法100的执行实体实现了在客户端与服务器之间的代理功能,从而可以在生成接口文档的同时满足客户端接入服务器以获得信息和内容等服务的要求。在一些实施例中,方法100中的获得与域名有关的接口信息因此可以包括:从传入消息和返回消息中的至少一个消息中获得接口信息。在一些实施例中,从传入消息和返回消息中的至少一个消息中获得接口信息可以进一步包括:通过对传入消息和返回消息中的至少一个消息进行解析,来获得接口信息。本领域的技术人员可以理解,方法100的执行实体可以采用任何已知的方法来解析传入消息和返回消息中的至少一个消息,本公开的实施例在这个方面不受限制。
[0031]在一些实施例中,基于接口信息来生成接口文档可以进一步包括:将预配置的接口参数描述写入接口文档中。在这个方面,预配置的接口参数描述可以是由方法100的执行实体的管理员预先配置的对于将要生成的接口文档中的接口参数的配置有关的描述。在一些实施例中,方法100的执行实体可以利用所获得的接口信息与预配置的接口参数描述相配合地来生成接口文档,从而可以符合管理员的要求。
[0032]图2示意性地示出了根据本公开的一个实施例的用于生成接口文档示意性原理图。如图2中所示出的,客户端201可以与执行根据本发明的实施例的方法100的工具202进行交互。具体而言,除了其他的各种交互之外,客户端201可以将用于接入服务器203的消息发送给工具202,而在相反的方向上,工具202可以将来自服务器203的消息转发给客户端201。在一些实施例中,客户端201可以包括用户用于接入服务器203的任何设备,例如,移动设备或web浏览器。
[0033]此外,工具202可以与服务器进行交互。具体而言,除了其他的各种交互之外,工具202可以将来自客户端201的消息转发给服务器203,而在相反的方向上,服务器203可以将针对该消息的返回消息发送给工具202。在一些实施例中,服务器203可以包括互联网上提供各种内容或服务的服务器,例如,提供网页的网站服务器。
[0034]通过分别与客户端201和服务器203之间的交互,工具202在它们之间充当了代理,从而实现了客户端201接入服务器203的操作。在这个过程中,执行根据本发明的实施例的方法100的工具202,还可以按照管理员的预定设置,从客户端201和服务器203之间往来的信息中获得与特定域名有关的接口信息,并且进一步地根据所获得的接口信息来自动地生成接口文档204。在一些实施例中,该预定设置可以由管理员用来向工具202指示针对哪些域名需要进行生成接口文档的操作。
[0035]图3示意性地示出了根据本公开的另一个实施例的用于生成接口文档示意性原理图。
[0036]如图3中所示出的,用于执行根据本发明的实施例的方法100的另一工具301可以具体地包括代理模块3011和文档生成模块3012。在一个实施例中,在HTTP协议的环境中,代理模块3011可以与HTTP消息流305进行交互,这种交互可以包括接收来自其他实体的HTTP消息,并且将来自于服务器的消息发送给其他实体。在图3的示例中,为了简单而没有描绘出可以与代理模块3011进行交互的服务器。代理模块3011还可以从域名配置模块302得知需要针对哪些域名进行生成接口文档的操作。本领域的技术人员可以理解,域名配置模块302可以采用各种方式来通知代理模块3011所需要生成接口文档的域名,管理员也可以用各种方式在域名配置模块302中设置需要生成接口文档的域名,本公开的实施例在这些方面不受限制。
[0037]文档生成模块3012可以基于获得的接口信息来生成接口文档304,该生成还可以进一步基于来自于参数配置模块303的信息。管理员可以通过参数配置模块303来设置将要生成的接口文档中的接口参数的配置有关的描述。在一些实施例中,文档生成模块3012可以利用所获得的接口信息与参数配置模块303中预配置的接口参数描述相配合地来生成接口文档,从而可以符合管理员的要求。
[0038]在一个更为具体的示例中,用户可以在其移动电话的WIFI设置中修改HTTP代理,指向执行根据本发明的实施例的方法的实体(例如,工具301)所在的机器和使用的端口,并且可以通过域名配置模块302对工具301需要过滤的域名进行配置。当客户端发送的请求消息经过工具301时可以进行解析并生成接口文档。
[0039]在启动工具301时,工具301可以读取制定目录的两个配置文件,它们分别记录了需要进行解析的域名以及接口参数的描述,将它们写入内存,待后续的过滤和生成使用。在工具301启动成功并且用户的移动电话也连入工具301的代理之后,所有来自用户移动电话的HTTP请求消息都将通过工具301中的代理模块3011进行转发。
[0040]当消息通过代理模块3011时,工具301可以将消息中的URL(统一资源定位符,例如http://www.baidu.com/dd/aa)解析出来,然后可以将URL中的域名解析出来(例如,www.baidu.com),将解析出的域名与内存中需要生成接口文档的域名列表进行匹配,若包含在需要生成接口文档的域名列表中,则将进行对消息的记录解析,同时将消息转发给服务器,再将服务器返回的消息进行记录解析,通过文档生成模块3012将记录的信息生成到HTML接口文档304中。若不在需要生成接口文档的域名中则仅进行转发代理功能,不再进行记录生成接口文档。
[0041]在生成HTML接口文档304时,文档生成模块3012可以根据启动时从参数配置模块303读取的参数描述配置,将参数描述同时写入HTML接口文档304,从而形成一份清晰的接口文档。工具301可以基于编程语言,利用HTTP原理并且实现HTTP代理,将得到的消息进行解析及处理,完成文档的自动生成。
[0042]图4示意性地示出了根据本
当前第2页1 2 3 
网友询问留言 已有0条留言
  • 还没有人留言评论。精彩留言会获得点赞!
1