Skip to content
Last updated

paths-kebab-case

Require kebab-case in paths instead of camelCase or snake_case.

OASCompatibility
2.0✅
3.0✅
3.1✅
3.2✅

API design principles

The base URL is case insensitive. The paths are case sensitive. It's a good practice to NOT confuse anyone, including yourself, with that fact, by using lowercase paths.

However, whatsapersontodowhenapathbecomesreallyhardtoread? Use the de facto standard of kebab-case.

Let's see if that question from above is easier to read this time around: whats-a-person-to-do-when-a-path-becomes-really-hard-to-read? That's what we thought!

Configuration

OptionTypeDescription
severitystringPossible values: off, warn, error. Default off (in recommended configuration).

An example configuration:

rules:
  paths-kebab-case: error

Examples

Given this configuration:

rules:
  paths-kebab-case: error

Example of an incorrect path:

paths:
  /customer_orders/{id}:
    post:
      parameters:
        - name: id
          in: path
          required: true

Example of a correct path:

paths:
  /customer-orders/{id}:
    post:
      parameters:
        - name: id
          in: path
          required: true
          description: The customer's ID.

Resources

 
Next page