Skip to main content
 首页 » 编程设计

python之添加链接到实现 HATEOAS 的 python-eve API 资源

2025年05月04日6mq0036

我正在使用 python-eve 构建 API .

我的设计很简单,它有两种资源,用户和设备:

  • /用户[/ID]
  • /用户/ID/设备[/ID]

代码是(settings.py)是:

users_schema = { 
  'nickName': { 
    'type': 'string', 
    'required': True, 
  }, 
  'email': { 
    'type': 'string', 
    'required': True, 
    'unique': True 
  } 
} 
 
devices_schema = { 
  'name': { 
    'type': 'string', 
    'required': True, 
  }, 
  'user_id': { 
    'type': 'objectid', 
     'data_relation': { 
        'resource': 'users', 
        'embeddable': True 
    }, 
  } 
 } 
 
users = { 
  'item_title': 'user', 
  'url': 'users', 
  'schema': users_schema, 
} 
 
user_devices = { 
  'resource_title': 'devices', 
  'url': 'users/<regex("[a-f0-9]{24}"):user_id>/devices', 
  'schema': devices_schema, 
  'datasource': { 
    'source': 'devices', 
  } 
} 
 
DOMAIN = { 
 'users': users, 
 'user_devices': user_devices  
} 

如果我创建一个用户,用户资源看起来像 (/users/54465ae80640fd0f60f6aa09):

{ 
"_updated": "Tue, 21 Oct 2014 13:08:56 GMT", 
"_etag": "d6ff9457f5b196a8c245a7dc91e7fca0d28c5268", 
"_links": { 
    "self": { 
        "href": "/users/54465ae80640fd0f60f6aa09", 
        "title": "user" 
    }, 
    "parent": { 
        "href": "", 
        "title": "home" 
    }, 
    "collection": { 
        "href": "/users", 
        "title": "users" 
    } 
}, 
"_created": "Tue, 21 Oct 2014 13:08:56 GMT", 
"_id": "54465ae80640fd0f60f6aa09", 
"nickName": "superuser", 
"email": "super@user.com" 
} 

HATEOAS 默认启用。 在之前的资源中,我期待一个指向用户设备的链接,指向 /users/54465ae80640fd0f60f6aa09/devices,因为这个端点存在,在代码 (user_devices) 中定义,并且工作正常。

我可以让谁让 pyhon-eve 了解用户和用户设备之间的关系,以便将此设备链接添加到用户资源?否则用户54465ae80640fd0f60f6aa09将不知道如何获取设备。

我期待这样的事情:

{ 
"_updated": "Tue, 21 Oct 2014 13:08:56 GMT", 
"_etag": "d6ff9457f5b196a8c245a7dc91e7fca0d28c5268", 
"_links": { 
    "self": { 
        "href": "/users/54465ae80640fd0f60f6aa09", 
        "title": "user" 
    }, 
    "devices": { 
        "href": "/users/54465ae80640fd0f60f6aa09/devices", 
        "title": "devices" 
    }, 
    "parent": { 
        "href": "", 
        "title": "home" 
    }, 
    "collection": { 
        "href": "/users", 
        "title": "users" 
    } 
}, 
"_created": "Tue, 21 Oct 2014 13:08:56 GMT", 
"_id": "54465ae80640fd0f60f6aa09", 
"nickName": "superuser", 
"email": "super@user.com" 
} 

在哪里“显而易见”如何获得设备。

非常感谢。

请您参考如下方法:

您也必须在用户 => 设备之间添加链接

users_schema = { 
      'nickName': { 
        'type': 'string', 
        'required': True, 
      }, 
    'data_relation': { 
        'resource': 'user_devices',  # link to device on a field _id 
        'field': '_id', 
        'embeddable': True 
    }, 
      'email': { 
        'type': 'string', 
        'required': True, 
        'unique': True 
      } 
    }