篮球规则

共同建筑规则 篮球 输油管。 这些规则可与任何篮板投篮手一起使用,并可与任何其他篮板规则结合使用.

说明

选项

默认情况下,违反本规则的行为将被显示为出错. 这可能会被 severity 选项 :

{
  "rules": [
    {
      "rule": "@basketry/rules/lib/description",
      "options": { "severity": "warning" }
    }
  ]
}

参数长度

选项

默认情况下,违反此规则将被显示为出错. 这可能会被 severity 选项 :

{
  "rules": [
    {
      "rule": "@basketry/rules/lib/array-parameter-length",
      "options": { "severity": "warning" }
    }
  ]
}

HTTP 状态代码

选项

默认情况下,违反本规则的行为将被显示为出错. 这可能会被 severity 选项 :

{
  "rules": [
    {
      "rule": "@basketry/rules/lib/http-status",
      "options": { "severity": "warning" }
    }
  ]
}

倾斜

选项

默认情况下,违反本规则的行为将被显示为出错. 这可能会被 severity 选项。 此规则允许赤色阵列和信封对象返回类型 。 默认情况下,有效载荷将位于称为 value, (中文(简体) ), values,或 data这些期望可能会被以下因素压倒: payload 选项.

如果为这种方法定义了HTTP协议信息,那么规则只适用于HTTP GET方法. 这可能会被 verb 或者说 verbs 选项.

{
  "rules": [
    {
      "rule": "@basketry/rules/lib/offset-pagination",
      "options": {
        "severity": "warning",
        "payload": ["result", "results"],
        "verbs": ["GET", "POST"]
      }
    }
  ]
}

为了有选择地适用该规则,使用 allow编号 :deny 列表中包含方法名称.

在以下例子中,该规则只将在 myPaginatedMethod. 授标规则 不会 以任何方法执行 没有 输入 allow 列表中选择一个选项.

{
  "rules": [
    {
      "rule": "@basketry/rules/lib/offset-pagination",
      "options": { "allow": ["myPaginatedMethod"] }
    }
  ]
}

在下面的例子中,该规则将不强制执行于 myUnpaginatedMethod. 授标规则 将 对所有方法执行 没有 输入 deny 列表中选择一个选项.

{
  "rules": [
    {
      "rule": "@basketry/rules/lib/offset-pagination",
      "options": { "deny": ["myUnpaginatedMethod"] }
    }
  ]
}

两者同时使用 allow 财务报告和审定财务报表 deny 清单可能导致无法预测的结果.

字符串标识

选项

默认情况下,违反此规则将被显示为出错. 这可能会被 severity 选项 :

{
  "rules": [
    {
      "rule": "@basketry/rules/lib/string-id",
      "options": { "severity": "warning" }
    }
  ]
}

答复信封

选项

默认情况下,违反本规则的行为将被显示为出错. 这可能会被 severity 选项。 此规则既允许赤出阵列,也允许 Everlope 对象返回类型 。 默认情况下,有效载荷预计将位于称为 value, (中文(简体) ), values,或 data。这些期望可能与 payload 选项。 请注意,其他规则可能强制执行各种复数化要求,因此必须同时包括有效载荷名称的复数和单数形式.

{
  "rules": [
    {
      "rule": "@basketry/rules/lib/response-envelope",
      "options": {
        "severity": "warning",
        "payload": ["result", "results"]
      }
    }
  ]
}

对象

选项

默认情况下,违反本规则的行为将被显示为出错. 这可能会被 severity 选项.

{
  "rules": [
    {
      "rule": "@basketry/rules/lib/object-body",
      "options": { "severity": "warning" }
    }
  ]
}

没有丢弃的 HTTP 天体

HTTP/1.1规格(RFC 7231)要么禁止身体,要么没有定义某些HTTP方法的身体行为. 在这些情况下,某些系统可能忽视、拒绝或失败,如果提供了一个机构。 以下规则禁止为这些HTTP方法定义机构.

选项

默认情况下,违反本规则的行为将被显示为出错. 这可能会被 severity 选项.

{
  "rules": [
    {
      "rule": "@basketry/rules/lib/no-disallowed-http-body",
      "options": { "severity": "warning" }
    }
  ]
}

多元化

选项

默认情况下,违反此规则将被显示为出错. 这可能会被 severity 选项 :

{
  "rules": [
    {
      "rule": "@basketry/rules/lib/string-id",
      "options": { "severity": "warning" }
    }
  ]
}

线索

选项

编组值必须是以下之一:

• snake - 如一些 项目 名称
• pascal - 比如,一些项目Name
• camel - 比如说一些项目Name
• kebab - 比如一些物品名称
• header - 比如,一些项目... Name
• constant' - 比如说,有些东西

任何其他外壳值都将默默被忽略.

可在服务中执行外壳规则时使用下列立体:

• enum
• enumValue
• path
• method
• parameter
• query
• header
• property
• type

注意,如果 query 或者说 header 当 parameter 实值 (单位:千美元) 提供,然后对信头和查询参数的更具体规则将取代所有其他参数的设置。 若为 query 或者说 header 为: 没有 提供的值,用于 parameter 还将用于信头和查询参数.

默认情况下,违反此规则将被显示为出错. 这可能会被 severity 选项.

{
  "rules": [
    {
      "rule": "@basketry/rules/lib/casing",
      "options": {
        "severity": "warning",
        "enum": "camel",
        "enumValue": "constant",
        "path": "kabab",
        "method": "camel",
        "parameter": "camel",
        "query": "kabab",
        "header": "header",
        "property": "camel",
        "type": "camel"
      }
    }
  ]
}

如果某一特定元素没有指定外壳规则,则允许任何外壳. 没有默认值 .

警告: 改变 enum 值的外壳, 路径, 查询参数, 和属性 是 HTTP( aka RESTful) 服务的突破性改变, 因为这些值直接在 HTTP 请求或响应中传递 。 查询参数在技术上不区分大小写。 Enum,方法,和类型名称从未包含在HTTP流量中.

也注意到,各种发电机可能发出一种特定语言所特有的代码,而不论这些外壳规则如何;然而,所有生成的代码MUST在跨越服务界限进行通信时都会在所指定的外壳中发送并接收值并(或)尊重它们与之订立的协议的外壳要求.

JSON: API 错误

选项

默认情况下,违反此规则将被显示为出错. 这可能会被 severity 选项.

默认情况下,这需要严格符合JSON:API出错对象谱. 当严格模式下, status 如果定义了, 则必须是字符串值, 并且 code 无法定义为 enum时 strict 明确设定为 false (单位:千美元)true (默认),然后 status 可以是数字类型,并且 code 可以是字符串 enum 类型.

{
  "rules": [
    {
      "rule": "@basketry/rules/lib/json-api-error",
      "options": {
        "severity": "warning",
        "strict": false
      }
    }
  ]
}

创建于 发电机控制台