Enforces plural path segments.
| OAS | Compatibility |
|---|---|
| 2.0 | ✅ |
| 3.0 | ✅ |
| 3.1 | ✅ |
RESTful API design often uses resources in path segments and those resources are typically plural.
For example, "customers" instead of "customer" because:
GET /customersmeans getting a collection of customersGET /customers/abcmeans getting customer ABC from the customers collection
As your API grows, you may hit some false positives and may also need to ignore a few outliers. That is, unless you're a purist. Nothing wrong with that.
| Option | Type | Description |
|---|---|---|
| severity | string | Possible values: off, warn, error. Default off (in recommended configuration). |
| ignoreLastPathSegment | boolean | Ignores the last path segment if true. Default value: false. |
| exceptions | [string] | List of strings to exclude when checking path segments, for example, v1. |
An example configuration:
rules:
path-segment-plural: errorAnother example configuration:
rules:
path-segment-plural:
severity: error
ignoreLastPathSegment: true
exceptions:
- v1
- v2
- peopleGiven this configuration:
rules:
path-segment-plural: errorExample of an incorrect path segment:
paths:
/customer/{id}:
post:
parameters:
- name: id
in: path
required: trueExample of a correct path segment:
paths:
/customers/{id}:
post:
parameters:
- name: id
in: path
required: true
description: The customer's ID.