# `Oaskit.Spec.Paths`
[🔗](https://github.com/lud/oaskit/blob/v0.13.1/lib/oaskit/spec/paths.ex#L1)

Representation of the [ Paths Object](https://spec.openapis.org/oas/v3.1.1.html#paths-object) in OpenAPI Specification.

# `from_router`

Accepts a Phoenix router module and returns paths that point to a controller
with operations defined for its actions.

### Options

* `:filter` - A predicate function to limit routes defined in your OpenAPI
  specification. This predicate is not called for every route, only on routes
  that define an operation.
* `:unprefix` - A string to remove from the beginning of the paths keys.
  Useful if your server path already contains a prefix like `"/api/v1"`. In
  the OpenAPI Specification, paths are always relative to the server path,
  even when starting with `"/"`.

# `from_routes`

Same as `from_router/2` but directly accepts the return value of
`router_module.__routes__()`.

# `json_schema`

---

*Consult [api-reference.md](api-reference.md) for complete listing*