swagger-jsdoc api的标题怎么写
时间: 2024-03-29 09:29:14 浏览: 164
Swagger-jsdoc API的标题应该简洁明了,准确描述该API所提供的服务。通常采用动词+名词的结构,例如:
- 获取用户信息
- 创建订单
- 更新商品信息
同时,为了更好地区分不同的API,建议在标题中添加一些关键信息,如HTTP方法、路径、参数等,例如:
- GET /users/{id} 获取指定用户信息
- POST /orders 创建新订单
- PUT /products/{id} 更新指定商品信息
最后,为了保持一致性,标题应该采用大写字母开头,使用活用名词或动词短语,避免使用缩写或缩略语。
阅读全文