我们如何让API使用者知道在RESTful中创建资源需要哪些数据？

假设有一个新的学生要被创造出来。因此，设计将发布在/学生上。但是api使用者如何知道创建学生所需的所有字段？我找不到任何RESTful文档来指定这一点。

这取决于您的需求。您应该有API文档，可以在其中告诉API使用者在http POST请求时应该有哪些数据。

---

你告诉规则

这取决于你的要求。您应该有API文档，可以在其中告诉API使用者在http POST请求时应该有哪些数据。

---

如果您想提供有关如何使用REST API的完整信息和文档，请告诉规则。它主要用于这方面的工具。如果您想提供有关如何使用REST API的完整信息和文档，请特别查看。

。它主要用于这方面的工具。特别是看

我们如何让API使用者知道在RESTful中创建资源需要哪些数据

简短回答：文档

记录web API，列出可用的端点、支持的方法、端点将使用和生成的媒体类型、所需输入、预期输出、错误代码等

---

但根据RESTful原则，API应该是自描述性的

你错过了自我描述的全部意义。请参阅Roy T.Fielding博士论文中定义REST架构的以下引用：

REST通过将消息约束为自描述性来实现中间处理：请求之间的交互是无状态的，标准方法和媒体类型用于指示语义和交换信息，响应明确指示可缓存性

本文探讨了应用的方法，并提供了有关的更多详细信息

我们如何让API使用者知道在RESTful中创建资源需要哪些数据

简短回答：文档

记录web API，列出可用的端点、支持的方法、端点将使用和生成的媒体类型、所需输入、预期输出、错误代码等

---

但根据RESTful原则，API应该是自描述性的

你错过了自我描述的全部意义。请参阅Roy T.Fielding博士论文中定义REST架构的以下引用：

REST通过将消息约束为自描述性来实现中间处理：请求之间的交互是无状态的，标准方法和媒体类型用于指示语义和交换信息，响应明确指示可缓存性

---

探索了应用的方法，并提供了有关的更多详细信息。

为您的api生成文档页面并在其中指定。或者，使用graphql。这是一个完全不同的api模型，但它有可执行的模式，而且使用起来非常好。但是根据RESTful原则，api应该是自描述性的。嗯？请给我指出这项索赔的来源：@SergioTulentsev我认为OP没有抓住自我描述的意义。我在我的文章中引用了菲尔丁的论文。为您的api生成文档页面并在那里指定它。或者，使用graphql。这是一个完全不同的api模型，但它有可执行的模式，而且使用起来非常好。但是根据RESTful原则，api应该是自描述性的。嗯？请给我指出这项索赔的来源：@SergioTulentsev我认为OP没有抓住自我描述的意义。我在我的文章中引用了菲尔丁的论文。但根据RESTful原则，API应该是自描述性的。是的，你是对的。它仍然是自描述性的，但只适用于应该用来处理数据的HTTP方法。但根据RESTful原则，API应该是自描述性的。是的，你是对的。它仍然是自描述性的，但仅适用于应用于处理数据的HTTP方法。事实上，似乎是这样。事实上，似乎是这样。