Skip to main content

Crate use_api_resource

Crate use_api_resource 

Source
Expand description

§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

Structs§

ApiResourceCollection
ApiResourceId
ApiResourceName
ApiResourcePath
ApiResourceRelationship
PrimitiveMetadata
Lightweight metadata tying this crate’s primary text and label together.

Enums§

ApiPrimitiveError
Error returned when API primitive text or labels are invalid.
ApiResourceAction
API resource action labels.