当前位置: 首页 > 知识库问答 >
问题:

URI和响应中参数的API最佳实践

东方华晖
2023-03-14

我试图遵循API的最佳实践,但我得到了相互矛盾的建议。大多数人建议对URI使用脊柱病例(例如stackoverflow和RFC3986。我有一个API,允许通过各种参数过滤GET请求:

< code >获取/终结点?my-parameter=true

但是,我也在 GET 响应和 PATCH 请求中使用相同的参数。在那里,我看到更多的骆驼大小写或snake_case,脊柱大小写是一个额外的语言,不允许在变量名称中使用连字符。所以我用这个:

   { 
      myParameter: true
   }

这似乎不一致。处理这些案件的最佳做法是什么?

共有1个答案

柯学
2023-03-14

正如埃弗特所说,这个问题没有正确答案。

spinal case被排除在外,因为它不适用于JavaScript等一些语言的基本语法格式。例:回应。用户名将中断,必须写入响应[“用户名”]

因此,我们只剩下骆驼壳和snake_case。在这些中,我个人更喜欢snake_case因为它比骆驼大小写更清晰地区分单词。

因此,使用哪一个完全取决于您的意见,但请确保您在所有API中都遵循它。

 类似资料:
  • 我的应用程序与一些外部服务集成,并向该服务请求数据。我只是想知道在客户端建模响应的最佳实践是什么,尤其是在客户端业务逻辑只需要一些数据的情况下。我正在考虑以下实施: 将JSON转换为包含所有数据/属性的类对象,并在我的代码中使用此类对象 将JSON转换为仅包含进一步处理所需的数据/属性的类对象 以上两者的组合(创建包含所有属性的类对象,然后将其转换为仅包含进一步业务逻辑所需属性的对象)

  • 想改进这个问题吗 更新问题,通过编辑这篇文章,可以用事实和引用来回答。 API响应应该始终是JSON对象,键和值是json数组吗?因此: 或者 API 响应本身可以只是一个数组?我找不到这方面的最佳实践是什么,如果一个被认为是一个糟糕的方法。

  • 我有一个RESTful Web API项目,我有2个不同的Enum场景,我不确定是最佳实践。 场景1:简单的枚举参数 我的API方法需要一个名为的参数,有效值为和。Web API项目中的枚举如下所示: 我对这个场景的问题是,我应该使用<code>吗?ruleType=EmailAddress(它会自动将该值绑定到API方法中的property)?如果是,如何最好地验证发送的<code>RuleTy

  • 问题内容: 因此,这里没有什么新鲜事,我只是想澄清一下,似乎无法在其他帖子中找到任何内容。 我正在重新创建新资源,说: 与身体: 我知道我应该返回带有新资源的Location标头的201(创建的): 我似乎无法为自己回答的问题是服务器应该返回什么内容。 我经常这样做: 我这样做有两个原因: 我已经为诸如angularjs的前端框架编写了api。在我的特定情况下,我使用的是角度资源,我通常只需要ID

  • 我正在spring boot中编写RESTAPI-s。我想确保我的代码对于使用swagger API开发工具(swagger)的前端开发人员是可读的。例如 如果请求成功,响应是一个分支对象,如果失败,响应是只有一个属性(消息)的FindError对象。因此,这两种方法的执行取决于响应。但是swagger UI没有显示响应应该如何显示,因为我使用了“?”作为泛型类型。这是捕捉错误的最佳实践吗?(这种

  • 我想回复ResponseEntity的回复。我对在ResponseEntity中提到返回类型的最佳实践有点困惑。 这是我的控制器: 我的主要责任: 这里我的返回类型是GenericResponse、AdminAccount。在ResponseEntity中提及所有退货类型是否是一种良好的做法? 哪个是最好的方法