软件学报

作者：周芯宇，陈伟，吴国全，魏峻

单位：周芯宇，中国科学院 软件研究所, 北京 100190;中国科学院大学, 北京 10004911,陈伟，中国科学院 软件研究所, 北京 100190;中国科学院大学, 北京 10004902,吴国全，中国科学院 软件研究所, 北京 100190;中国科学院大学, 北京 100049;计算机科学国家重点实验室 (中国科学院 软件研究所), 北京 10019003,魏峻，中国科学院 软件研究所, 北京 100190;中国科学院大学, 北京 100049;计算机科学国家重点实验室 (中国科学院 软件研究所), 北京 10019004

关键词：REST API;设计指导规范;分类体系;API描述文档;实证研究

基金：国家重点研发计划(2017YFB1400602); 国家自然科学基金重点项目(61732019); 并行与分布处理国防科技重点实验室基金一般项目(61421102000402)

REST API已成为访问和使用Web服务的重要途径, 为开发基于服务架构的应用系统提供了可复用接口. 但是, REST API的设计质量参差不齐, 因此有效、合理的设计指导规范对于规范和提高REST API设计质量具有现实意义和应用价值. 首先, 基于REST API的本质内涵, 建立了一个多维度、两层次的REST API设计指导规范分类体系RADRC (REST API design rule catalog), 并对当前主流的25条设计指导规范进行分类. 其次, 针对已有规范提出相应的检测方法, 并实现了REST API设计指导规范遵循情况的分析与检测工具RESTer. 最后, 使用RESTer开展REST API设计实证研究, 分析了APIs.guru收录的近2000个真实REST API的文档, 从中分析提取相应的REST API信息, 进一步检测并统计当前REST API的设计特征和设计指导规范遵循情况. 研究发现不同应用类别的REST API在资源和操作模式上存在差异, 使得不同类别REST API在设计规则和总体架构方面各有特点. 实证研究结果有助于深入了解当前REST API及其设计规则的特征、现状和不足, 对于提高REST API设计质量和改进设计指导规范具有实际意义.

来源：2022年第9期

《软件学报》期刊编辑部

查看软件学报杂志2022年第9期