限制对 RESTful API 中特定字段的更新

发布于 2024-11-17 09:54:09 字数 155 浏览 3 评论 0原文

假设我有一个对象 Widget，由 Id 和 Name 组成。假设我公开了一个端点 /widget，客户端可以在其中发布新的 Widget 对象。如果我希望Id字段始终由服务器设置，客户端不可修改，但对客户端仍然可见，如何声明Id字段不可修改？如果这有什么区别的话，我正在使用 RESTeasy。

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

不必在意 2024-11-24 09:54:09

我可以想到几个选择。

首先，您确定需要公开 ID 作为表示的一部分吗？或者用新发布的资源的位置进行响应就足够了吗？

您的客户发帖：

<Resource><Name>New Resource</Name></Resource>

您回应：

HTTP/1.1 201 Created
...
Location: /resources/{new_resource_id}

除此之外，我认为与您的客户进行一些简单、易于理解的约定是可以的。我认为大多数开发人员都明白 ID 可能是系统生成的（特别是，因为您正在执行 POST 而不是 PUT）。对于不太明显的情况，您有任意只读字段（或其他验证或显示信息），我认为提供元数据的链接可能是有意义的：

<NewPersonForm>
    <atom:link href="/people/new/metadata" rel="/rels/metadata" />
    <Name />
    <Department>HR</Department>
</NewPersonForm>

元数据的外观取决于您，但沿着这些思路可能对你有用：

<Metadata>
    <Element>
        <Name>Department</Name>
        <IsReadOnly>True</IsReadOnly>
    </Element>
</Metadata>

这是一种很好的、格式中立的（它适用于 XML 和 JSON）方式向客户端提供信息，如果他们真的想要，他们可以针对它进行编程来动态构建表单（我用它来提供验证信息、特定于语言的标签，以及数据类型信息）。

我希望这有帮助。

约翰

I can think of a few options.

First, are you sure you need to expose the ID as part of the representation? Or is it enough to respond with the location of the new posted resource?

Your client posts:

<Resource><Name>New Resource</Name></Resource>

And you respond:

HTTP/1.1 201 Created
...
Location: /resources/{new_resource_id}

Beyond that, I think it's OK to have some simple, well-understood conventions with your clients. I think most developers understand that an ID is likely to be system-generated (especially, since you're doing a POST and not a PUT). For less obvious cases, where you have arbitrary read-only fields (or other validation or display information), I think it may make sense to provide a link to metadata:

<NewPersonForm>
    <atom:link href="/people/new/metadata" rel="/rels/metadata" />
    <Name />
    <Department>HR</Department>
</NewPersonForm>

What the metadata looks like is up to you, but something along these lines might work for you:

<Metadata>
    <Element>
        <Name>Department</Name>
        <IsReadOnly>True</IsReadOnly>
    </Element>
</Metadata>

That's a nice, format-neutral (it works well for both XML and JSON) way to provide information to the client, and if they really want to, they can program against it to build forms on the fly (I use it to provide validation information, language-specific labels, and data type information).

I hope this helps.

John

回复收藏 0 原文