use-api-schema 0.0.1

Models schema names, schema fields, field kinds, required or optional markers, nullable markers, and broad schema shape labels without becoming a full schema system.
Documentation
  • Coverage
  • 95.56%
    43 out of 45 items documented1 out of 27 items with examples
  • Size
  • Source code size: 14.91 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.02 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 2s Average build duration of successful builds.
  • all releases: 2s 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-schema

API schema primitives for RustUse.

Models schema names, schema fields, field kinds, required or optional markers, nullable markers, and broad schema shape labels without becoming a full schema system.

Example

use use_api_schema::{FieldKind, SchemaName};

let value = SchemaName::new("User").expect("valid API primitive");

assert_eq!(value.as_str(), "User");
assert_eq!(FieldKind::String.to_string(), "string");

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 JSON Schema implementation.
  • No OpenAPI schema generator.
  • No GraphQL schema engine.

License

Licensed under either of the following, at your option:

  • Apache License, Version 2.0
  • MIT license