API设计

这个部分没什么好说的,参照行业内的规范即可,本项目中使用的是类似于Restful的形式,舍弃了一定的表意元素,只是用GET和POST请求方式,以及POST请求使用200而不是201作为状态码,其他部分和Restful基本一致。在API文档的选择上,我们选择了OpenAPI 3.1的格式,使用swagger进行展示,使用Apicurio Studio平台进行设计。

相关文档:

一文搞懂什么是RESTful API - 知乎

OpenAPI Specification v3.1.0

Apicurio Studio