用于生成接口文档的方法和装置.pdf

(19)中华人民共和国国家知识产权局(12)发明专利(10)授权公告号CN104954363B(45)授权公告日2018.05.22(21)申请号201510217553.7(56)对比文件(22)申请日2015.04.30CN103383687A,2013.11.06,CN103095783A,2013.05.08,(65)同一申请的已公布的文献号US8245246B2,2012.08.14,申请公布号CN104954363ACN101499002A,2009.08.05,(43)申请公布日2015.09.30CN103049271A,2013.04.17,(73)专利权人北京嘀嘀无限科技发展有限公司CN101499002A,2009.08.05,地址100085北京市海淀区上地东路9号1徐向亮.《基于微博API的嵌入式设备远程控号楼5层北区1号制技术研究与应用》.《中国优秀硕士学位论文全文数据库（电子期刊）》.2015,(72)发明人肖德超审查员李晴晴(74)专利代理机构北京市金杜律师事务所11256代理人王茂华(51)Int.Cl.H04L29/06(2006.01)H04L29/08(2006.01)权利要求书2页说明书6页附图2页(54)发明名称用于生成接口文档的方法和装置(57)摘要本公开的实施例提供了一种用于生成接口文档的方法和装置。该方法包括：从来自客户端的传入消息中解析出域名；判断该域名是否在预配置的域名列表中；响应于该域名在域名列表中，获得与该域名有关的接口信息；以及基于接口信息来生成接口文档。CN104954363BCN104954363B权利要求书1/2页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所述的装置，其中所述获得单元进一步被配置为：从所述传入消息和所述返回消息中的至少一个消息中获得所述接口信息。2CN104954363B权利要求书2/2页14.根据权利要求13所述的装置，其中所述获得单元进一步被配置为：通过对所述传入消息和所述返回消息中的至少一个消息进行解析，来获得所述接口信息。15.根据权利要求11所述的装置，其中所述生成单元进一步被配置为：将预配置的接口参数描述写入所述接口文档中。16.根据权利要求11所述的装置，其中所述获得单元进一步被配置为：响应于所述域名不在所述域名列表中，不获得与所述域名有关的接口信息。17.根据权利要求11所述的装置，其中所述传入消息包括HTTP请求消息。18.根据权利要求17所述的装置，其中所述解析单元进一步被配置为：从所述HTTP请求消息中解析出统一资源定位符，并且从所述统一资源定位符解析出所述域名。19.