use-api-resource 0.0.1

Models resource names, identifiers, collections, paths, relationships, and actions useful across REST, GraphQL, RPC, and OpenAPI surfaces.
Documentation
  • Coverage
  • 88.37%
    38 out of 43 items documented1 out of 33 items with examples
  • Size
  • Source code size: 10.45 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 989.03 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 5s Average build duration of successful builds.
  • all releases: 5s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • RustUse/use-api
    1 0 0
  • crates.io
  • Dependencies
    • —
  • Versions
  • Owners
  • CloudBranch

use-api-resource

API resource primitives for RustUse.

Models resource names, identifiers, collections, paths, relationships, and actions useful across REST, GraphQL, RPC, and OpenAPI surfaces.

Example

use use_api_resource::{ApiResourceAction, ApiResourceName};

let value = ApiResourceName::new("users").expect("valid API primitive");

assert_eq!(value.as_str(), "users");
assert_eq!(ApiResourceAction::Read.to_string(), "read");

Scope

  • Small validated types for API metadata.
  • Stable display labels and conservative parsing helpers.
  • Dependency-light primitives that can be reused by other RustUse crates.

Non-goals

  • No persistence model.
  • No ORM behavior.
  • No authorization checks.

License

Licensed under either of the following, at your option:

  • Apache License, Version 2.0
  • MIT license