用于生成接口文档的方法和装置的制造方法
【技术领域】
[0001]本公开的实施例一般涉及计算机的技术领域，并且特别涉及一种用于生成接口文档的方法和装置。
【背景技术】
[0002]目前互联网公司服务器开放给客户端的接口往往非常多，而公司内部对于此类接口的文档却往往少之又少，造成内部学习交流成本被提高。书写此类文档要么人工、要么从代码中生成。对于一些从开始就严格遵守代码编写规则的产品，可以通过工具将代码中的信息进行提炼生成接口文档。但是就目前而言，更多的公司在开始阶段往往是没有统一严格的编写规范，没有办法进行自动的文档生成。即便后续严格执行了规范，对之前产出接口的梳理也会是一个很大的工作量，而且代码后续修改维护，也需要能够实时维护生成文档部分的更新，否则会造成接口实际实现与文档描述不一致。总之，维护API文档是一件不轻松的工作。
【发明内容】
[0003]鉴于现有技术中存在的上述问题，如果能够通过代理工具过滤需要进行统计的域名，进行接口参数的自动获取，并在获取之后自动生成API接口文档，那么编写API接口文档的效率可以大为提尚。
[0004]因此，本公开的实施例的目的之一在于提供一种用于生成接口文档的方法和装置，从而解决现有技术中所存在的上述问题。
[0005]根据本公开的第一方面，提供了一种用于生成接口文档的方法，该方法包括:从来自客户端的传入消息中解析出域名；判断该域名是否在预配置的域名列表中；响应于该域名在域名列表中，获得与该域名有关的接口信息；以及基于接口信息来生成接口文档。
[0006]根据本公开的一些实施例，该方法进一步包括:将传入消息转发给服务器，从服务器接收返回消息，并且将返回消息转发给客户端。
[0007]根据本公开的一些实施例，其中获得与该域名有关的接口信息包括:从传入消息和返回消息中的至少一个消息中获得接口信息。
[0008]根据本公开的一些实施例，其中从传入消息和返回消息中的至少一个消息中获得接口信息包括:通过对传入消息和返回消息中的至少一个消息进行解析，来获得接口信息。
[0009]根据本公开的一些实施例，其中基于接口信息来生成接口文档进一步包括:将预配置的接口参数描述写入接口文档中。
[0010]根据本公开的一些实施例，该方法进一步包括:响应于该域名不在域名列表中，不获得与该域名有关的接口信息。
[0011 ] 根据本公开的一些实施例，其中传入消息包括HTTP请求消息。
[0012]根据本公开的一些实施例，其中从来自客户端的传入消息中解析出域名包括:从HTTP请求消息中解析出统一资源定位符，并且从统一资源定位符解析出域名。
[0013]根据本公开的一些实施例，其中接口文档包括HTML接口文档。
[0014]根据本公开的一些实施例，其中接口文档中至少包括:接口的路径、接口的方法、接口的参数名、接口的参数描述、或者接口的参数示例。
[0015]根据本公开的第二方面，提供了一种用于生成接口文档的装置，包括:解析单元，被配置为从来自客户端的传入消息中解析出域名；判断单元，被配置为判断该域名是否在预配置的域名列表中；获得单元，被配置为响应于该域名在域名列表中，获得与该域名有关的接口信息；以及生成单元，被配置为基于该接口信息来生成接口文档。
[0016]本公开的实施例运用了 HTTP原理，通过工具实现代理，过滤所配置的域名，能够实现将此域名下的所有接口信息获取并存储，解决了接口信息获取麻烦，人工输入繁琐的问题。此外，本公开的实施例通过获取的接口信息以及本地配置的参数说明，能够自动生成HTML的接口文档，解决了接口文档编写与维护困难的问题。
【附图说明】
[0017]通过参考附图阅读下文的详细描述，本公开的实施例的上述以及其他目的、特征和优点将变得容易理解。在附图中，以示例性而非限制性的方式示出了本公开的若干实施例，其中:
[0018]图1示意性地示出了根据本公开的一个实施例的用于生成接口文档的方法的流程图；
[0019]图2示意性地示出了根据本公开的一个实施例的用于生成接口文档示意性原理图；
[0020]图3示意性地示出了根据本公开的另一个实施例的用于生成接口文档示意性原理图；以及
[0021]图4示意性地示出了根据本公开的一个实施例的用于生成接口文档的装置的框图。
【具体实施方式】
[0022]下面将参考附图来描述本公开的实施例的原理和精神。应当理解，描述这些实施例仅是为了使本领域的技术人员能够更好地理解并实施本公开，而并非以任何方式限制本公开的范围。
[0023]图1示意性地示出了根据本公开的一个实施例的用于生成接口文档的方法100的流程图。一般而言，方法100可以用于自动地生成接口文档，并且同时能够实现客户端接入服务器的功能。在一些实施例中，方法100可以由根据本发明的一个实施例的用于生成接口文档的装置、工具、或者其他任何适当的实体来执行。
[0024]如图1中所示出的，方法100在开始之后进入步骤101。在步骤101中，从来自客户端的传入消息中解析出域名。在一些实施例中，方法100的执行实体可以从客户端接收到传入消息，这些传入消息可以包括由这些客户端发往服务器并且用来接入服务器的通信消息。本领域的技术人员可以理解，服务器可以位于接近或者远离客户端的任何地点，而客户端可以通过各种各样的有线或无线网络来接入服务器。在一些实施例中，这些传入消息中可以包括客户端希望访问的域名。在一些实施例中，客户端可以包括用户用来实现接入服务器的任何设备。在一些实施例中，客户端可以包括但不限于，能够实现域名访问功能的任何移动或者固定的设备。此外，本领域的技术人员可以使用任何已知的方法从这些传入消息中解析出域名，本公开的实施例在这个方面不受限制。
[0025]在一些实施例中，传入消息可以包括HTTP请求消息。本领域的技术人员可以理解，HTTP请求消息可以包括基于超文本传输协议(HTTP)的各种通信交互流程中的请求消息。在一些实施例中，从来自客户端的传入消息中解析出域名可以包括:从HTTP请求消息中解析出统一资源定位符(URL)，并且从统一资源定位符解析出域名。
[0026]接着，方法100前进至步骤102。在步骤102中，判断域名是否在预配置的域名列表中。在一些实施例中，方法100的执行实体从传入消息中解析出域名之后，可以判断该域名是否存在于预配置的域名列表中。在一些实施例中，预配置的域名列表可以是由方法100的执行实体的管理员预先进行配置的需要针对其生成接口文档的域名列表。本领域的技术人员可以理解，方法100的执行实体的管理员可以使用任何已知的方法来对预配置的域名列表进行配置，本公开的实施例在这个方面不受限制。
[0027]接着，方法100前进至步骤103。在步骤103中，响应于域名在预配置的域名列表中，获得与该域名有关的接口信息。在一些实施例中，如果方法100的执行实体在步骤102中判断出域名在预配置的域名列表中，则方法100的执行实体可以获得与该域名有关的接口信息。在一些实施例中，与域名有关的接口信息可以包括但不限于，接口的路