设计原则 📜
- 一致性 - 保持API行为与参数命名统一，如
/api/v1/users与/api/v1/products采用相同结构 - 简洁性 - 避免嵌套层级过深，建议保持路径深度不超过3层
- 语义化 - 使用动词描述操作（如
GET /docs获取文档），名词描述资源（如POST /projects创建项目）
示例代码 💻
# 接口示例
@app.route('/community/resources/knowledge/projects/<project_id>/docs', methods=['GET'])
def get_project_docs(project_id):
# 业务逻辑
return jsonify(docs)