RESTful-API接口编程思路和注意事项：flask为例

前言：

API的设计主要包含：

API路由设计

API权限设计

API接口统计和计费设计

API计费报表设计

API请求和响应的数据格式设计和响应码设计

 

一 开发阶段

1 设计API路由URL规范。

　　要使用restful  API设计API接口，绑定GET,POST,PATCH,DELETE作为查，增，改，删的方法，

　　比如数据集的增/查改删,假设用post创建一个数据集叫做dataset001

POST   http://api.helloworld.com/datasets  

GET    http://api.helloworld.com/datasets/dataset001
PATCH  http://api.helloworld.com/datasets/dataset001
DELETE http://api.helloworld.com/datasets/dataset001

 1 app.add_url_rule('/datasets', view_func=list_datasets, methods=['GET'])
 2 app.add_url_rule('/datasets', view_func=create_dataset, methods=['POST'])
 3 app.add_url_rule('/datasets/<dataset_name>', view_func=get_dataset, methods=['GET'])
 4 app.add_url_rule('/datasets/<dataset_name>', view_func=update_dataset, methods=['PATCH'])
 5 app.add_url_rule('/datasets/<dataset_name>', view_func=delete_dataset, methods=['DELETE'])
 6 app.add_url_rule('/datasets/<dataset_name>/items', view_func=list_dataset_items, methods=['GET'])
 7 app.add_url_rule('/datasets/<dataset_name>/items', view_func=create_dataset_item, methods=['POST'])
 8 app.add_url_rule('/datasets/<dataset_name>/items', view_func=update_dataset_items, methods=['PATCH'])
 9 app.add_url_rule('/datasets/<dataset_name>/items', view_func=delete_dataset_items, methods=['DELETE'])
10 app.add_url_rule('/datasets/<dataset_name>/items/<item_id>', view_func=get_dataset_item, methods=['GET'])
11 app.add_url_rule('/datasets/<dataset_name>/items/<item_id>', view_func=update_dataset_item, methods=['PATCH'])
12 app.add_url_rule('/datasets/<dataset_name>/items/<item_id>', view_func=delete_dataset_item, methods=['DELETE'])

flask实际路由