A REST API design quality assessment method
By establishing a RESTful specification system and combining OAS specifications, the design quality evaluation of REST API is solved, and the lack of analysis of API characteristics in the existing technology is solved, and the precise evaluation and design guidance of REST API design quality is achieved.
CN114625341BActive Publication Date: 2025-04-11INST OF SOFTWARE - CHINESE ACAD OF SCI
View PDF 0 Cites 0 Cited by
Patent Information
- Application Number
- CN202011456869.9
- Authority / Receiving Office
- CN · China
- Patent Type
- Patents(China)
- Current Assignee / Owner
- Filing Date
- 2020-12-10
- Publication Date
- 2025-04-11
- Estimated Expiration
- 2040-12-10
Smart Images

Figure CN114625341B_ABST
Abstract
The present invention discloses a REST API design quality evaluation method, the steps of which include: 1) establishing a set of RESTful specification systems; 2) obtaining or constructing an API description document data set, and classifying the documents according to API category information to obtain multiple domain data sets; 3) parsing each API description document, extracting the version number of the API description document, and then constructing a corresponding syntax tree for the API description document according to the version number; 4) detecting whether the component information of each syntax tree can be realized according to the RESTful specification system, and determining an evaluation reference value of the REST API; 5) determining an evaluation value P of a REST API to be detected; combining the domain j of the REST API to be detected and the corresponding domain evaluation reference value P j , evaluate the RESTful degree of the REST API to be tested.
Need to check novelty before this filing date? Find Prior Art