资源 Resource 的摆放

在使用Flask-RESTful的Resource类简化API开发步骤时，所有的资源都可以通过继承Resource类来构建一个单独的class，
并将所有与此资源相关的CRUD操作作为methods添加到对应的class下，使得整个程序结构更加清晰明了。

这种情况下，各资源之间互不影响，可以专门建立一个名为resources的文件夹，并将各资源class单独建立文件：

./resources
| --- __init__.py
|--- item.py
|--- user.py

注意在一些较旧的python版本中需要在文件夹中添加init.py来告诉python可以将其视为package。

更清晰的资源操作方法

使用各资源class下的get()方法来对应GET尝试获取资源。
最简单的情况下，只要根据发来的请求直接提供对应的信息即可。
比如，请求中包含了用户姓名，则返回姓名对应的用户信息：

# user.py
class User(Resource):

  def get(self, name):
    {% 根据提供的name从数据库中找到对应user的逻辑 %}
    return {'user': user}, 200 if user is not None else 404

而这段冗长的由name找到数据库中user的逻辑可以提取出来单独作为一个method使代码更优美：

# user.py
class User(Resource):

  def get(self, name):
    user = self.find_by_name(name)
    return {'user': user}, 200 if user is not None else 404

  @classmethod
  def find_by_name(cls, name):
    {% 根据提供的name从数据库中找到对应user的逻辑 %}
    return user

这样有了单独的find_by_name后，get只要直接调用它即可。

新 Method 到新 Class

将与底层数据库的交互逻辑转移到新的method中去可以大幅提高代码的可读性。
在此基础上我们还可以更进一步，将所有类似的逻辑从原资源中剥离出来，构建一个新class：

# user.py
class UserModel():

  @classmethod
  def find_by_name(cls, name):
    {% 根据提供的name从数据库中找到对应user的逻辑 %}
    return user
  

class User(Resource):

  def get(self, name):
    # Call the find_by_name() method from class UserModel
    user = UserModel.find_by_name(name)
    return {'user': user}, 200 if user is not None else 404

资源与模型

到目前为止，所有资源class中仅剩直接与API调用者直接交互的方法，get()/post()/put() ...
其余辅助CRUD操作的逻辑都被转移到了新的对应class中，由CRUD操作来调用，
比如之前用来举例的 Class User (资源) 对应 Class UserModel (辅助)。

为了更好的工程结构，可以把所有的辅助class单独成文件，
并集中到专门的models文件夹下，

#models/user.py

class UserModel:
  ...

#resources/user.py

from flask_restful import Resource, reqparse
from models.user import UserModel

class User(Resource):

  def get(self, name):
    # Call the find_by_name() method from class UserModel
    user = UserModel.find_by_name(name)
    return {'user': user}, 200 if user is not None else 404

文件名尽量便于识别，可以一眼认出与资源class的对应关系:

./resources
| --- __init__.py
|--- item.py
|--- user.py

./models
| --- __init__.py
|--- item.py
|--- user.py

因此，resources（资源）文件夹下都是外部API调用者直接交互的部分，
即API的外部展示，
models（模型）下则是各种内部逻辑（如与数据库的交互），
即API的内部表示。

整体交互关系如下：
API caller <--> resources <--> models <--> DataBases

这样，我们就可以得到一个较为清晰的代码结构。