公开的一个实施例的用于生成接口文档的装置400的框图。一般而言，装置400可以用于自动地生成接口文档，并且同时实现客户端正常访问服务器的功能。在一些实施例中，装置400可以用于执行根据本发明的一个实施例的用于生成接口文档的方法100。如图4中所示出的，装置400可以包括:解析单元401、判断单元402、获得单元403、以及生成单元404。
[0043]在一些实施例中，解析单元401可以被配置为从来自客户端的传入消息中解析出域名；判断单元402可以被配置为判断该域名是否在预配置的域名列表中；获得单元403可以被配置为响应于该域名在域名列表中，获得与该域名有关的接口信息；并且生成单元404可以被配置为基于接口信息来生成接口文档。
[0044]在一些实施例中，装置400可以进一步包括:转发单元，被配置为将传入消息转发给服务器；接收单元，被配置为从服务器接收返回消息。此外，转发单元还进一步被配置为将返回消息转发给客户端。
[0045]在一些实施例中，获得单元403可以进一步被配置为:从传入消息和返回消息中的至少一个消息中获得接口信息。在一些实施例中，获得单元403可以进一步被配置为:通过对传入消息和返回消息中的至少一个消息进行解析，来获得接口信息。在一些实施例中，获得单元403可以进一步被配置为:响应于域名不在域名列表中，不获得与该域名有关的接口信息。
[0046]在一些实施例中，生成单元404可以进一步被配置为:将预配置的接口参数描述写入接口文档中。在一些实施例中，传入消息可以包括HTTP请求消息。在一些实施例中，解析单元401可以进一步被配置为:从HTTP请求消息中解析出统一资源定位符，并且从统一资源定位符解析出域名。在一些实施例中，接口文档可以包括HTML接口文档。在一些实施例中，接口文档中至少可以包括:接口的路径、接口的方法、接口的参数名、接口的参数描述、或者接口的参数示例。
[0047]应当注意，本公开的实施例可以通过硬件、软件或者软件和硬件的结合来实现。硬件部分可以利用专用逻辑来实现；软件部分可以存储在存储器中，由适当的指令执行系统，例如微处理器或者专用设计硬件来执行。本领域的技术人员可以理解上述的设备和方法可以使用计算机可执行指令和/或包含在处理器控制代码中来实现，例如在可编程的存储器或者诸如光学或电子信号载体的数据载体上提供了这样的代码。
[0048]此外，尽管在附图中以特定顺序描述了本公开方法的操作，但是，这并非要求或者暗示必须按照该特定顺序来执行这些操作，或是必须执行全部所示的操作才能实现期望的结果。相反，流程图中描绘的步骤可以改变执行顺序。附加地或备选地，可以省略某些步骤，将多个步骤组合为一个步骤执行，和/或将一个步骤分解为多个步骤执行。还应当注意，根据本公开的两个或更多装置的特征和功能可以在一个装置中具体化。反之，上文描述的一个装置的特征和功能可以进一步划分为由多个装置来具体化。
[0049]虽然已经参考若干具体实施例描述了本公开，但是应当理解，本公开不限于所公开的具体实施例。本公开旨在涵盖所附权利要求的精神和范围内所包括的各种修改和等效布置。
【主权项】
1.一种用于生成接口文档的方法，包括: 从来自客户端的传入消息中解析出域名； 判断所述域名是否在预配置的域名列表中； 响应于所述域名在所述域名列表中，获得与所述域名有关的接口信息；以及 基于所述接口信息来生成所述接口文档。2.根据权利要求1所述的方法，进一步包括: 将所述传入消息转发给服务器， 从所述服务器接收返回消息，并且 将所述返回消息转发给所述客户端。3.根据权利要求2所述的方法，其中获得与所述域名有关的接口信息包括: 从所述传入消息和所述返回消息中的至少一个消息中获得所述接口信息。4.根据权利要求3所述的方法，其中从所述传入消息和所述返回消息中的至少一个消息中获得所述接口信息包括: 通过对所述传入消息和所述返回消息中的至少一个消息进行解析，来获得所述接口信息。5.根据权利要求1所述的方法，其中基于所述接口信息来生成所述接口文档进一步包括: 将预配置的接口参数描述写入所述接口文档中。6.根据权利要求1所述的方法，进一步包括: 响应于所述域名不在所述域名列表中，不获得与所述域名有关的接口信息。7.根据权利要求1所述的方法，其中所述传入消息包括HTTP请求消息。8.根据权利要求7所述的方法，其中从来自客户端的传入消息中解析出域名包括: 从所述HTTP请求消息中解析出统一资源定位符，并且 从所述统一资源定位符解析出所述域名。9.根据权利要求1所述的方法，其中所述接口文档包括HTML接口文档。10.根据权利要求1所述的方法，其中所述接口文档中至少包括:接口的路径、接口的方法、接口的参数名、接口的参数描述、或者接口的参数示例。11.一种用于生成接口文档的装置，包括: 解析单元，被配置为从来自客户端的传入消息中解析出域名； 判断单元，被配置为判断所述域名是否在预配置的域名列表中； 获得单元，被配置为响应于所述域名在所述域名列表中，获得与所述域名有关的接口信息；以及 生成单元，被配置为基于所述接口信息来生成所述接口文档。12.根据权利要求11所述的装置，进一步包括: 转发单元，被配置为将所述传入消息转发给服务器， 接收单元，被配置为从所述服务器接收返回消息，并且 其中所述转发单元还进一步被配置为将所述返回消息转发给所述客户端。13.根据权利要求12所述的装置，其中所述获得单元进一步被配置为: 从所述传入消息和所述返回消息中的至少一个消息中获得所述接口信息。14.根据权利要求13所述的装置，其中所述获得单元进一步被配置为: 通过对所述传入消息和所述返回消息中的至少一个消息进行解析，来获得所述接口信息。15.根据权利要求11所述的装置，其中所述生成单元进一步被配置为: 将预配置的接口参数描述写入所述接口文档中。16.根据权利要求11所述的装置，其中所述获得单元进一步被配置为: 响应于所述域名不在所述域名列表中，不获得与所述域名有关的接口信息。17.根据权利要求11所述的装置，其中所述传入消息包括HTTP请求消息。18.根据权利要求17所述的装置，其中所述解析单元进一步被配置为: 从所述HTTP请求消息中解析出统一资源定位符，并且 从所述统一资源定位符解析出所述域名。19.根据权利要求11所述的装置，其中所述接口文档包括HTML接口文档。20.根据权利要求11所述的装置，其中所述接口文档中至少包括:接口的路径、接口的方法、接口的参数名、接口的参数描述、或者接口的参数示例。
【专利摘要】本公开的实施例提供了一种用于生成接口文档的方法和装置。该方法包括：从来自客户端的传入消息中解析出域名；判断该域名是否在预配置的域名列表中；响应于该域名在域名列表中，获得与该域名有关的接口信息；以及基于接口信息来生成接口文档。
【IPC分类】H04L29/06, H04L29/08
【公开号】CN104954363
【申请号】CN201510217553
【发明人】肖德超
【申请人】北京嘀嘀无限科技发展有限公司
【公开日】2015年9月30日
【申请日】2015年4月30日