liveBook · Manning

Url path

As explained in Automating API Delivery

A URI path is the path component of a uniform resource identifier that identifies a resource or resource hierarchy in an API.

A URI path identifies a resource or resource hierarchy in an API. A practical governance rule can require every path to begin with a version segment such as /v{digit}/. section 3.7

Implement the rule by selecting path names with JSONPath Plus, then matching each selected value against a regular expression. Basic JSONPath cannot retrieve these property names directly. section 3.7

A repeatable path-versioning workflow is:

  • Evaluate $.paths[*]~ with jpp and confirm that it returns the document's URI paths. section 3.7

Automation handles mechanical path conventions, but broader API decisions may remain review work. Examples include requiring nouns for resources and reconsidering GET when query parameters expose sensitive or personally identifiable information. section 3.11

How Automating API Delivery covers it

How deep it goes
Descends from resource identification to JSONPath Plus selection, regular-expression matching, testing, and Spectral execution.
Examples
Uses product-catalog-v3.oas.yaml, yq conversion, jpp evaluation, and a version-matching Spectral ruleset.
What it assumes
Assumes an API definition and command-line access to yq, jpp, and Spectral for conversion, expression testing, and linting.
What you can do after
Apply it via Spectral to detect API paths that do not begin with a numeric version segment.
How it connects
Connects URI paths with API linting, Spectral, JSONPath Plus, API design review, and LLM-assisted linting.

Also explained in

Compare how 3 books explain url path →

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Automating API Delivery. The section links point to the parts of the book it draws on.