shaperail-codegen 0.2.1

YAML parser, validator, and code generator for Shaperail
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

# shaperail-codegen

YAML parser, validator, and code generator for the [Shaperail](https://github.com/shaperail/shaperail) framework.

## What it does

- **Parses** resource YAML files into `ResourceDefinition` structs
- **Validates** semantic correctness (enum needs values, refs must be uuid, etc.)
- **Generates** OpenAPI 3.1 specs from resource definitions
- **Generates** TypeScript client SDKs from OpenAPI specs

## Modules

| Module | Purpose |
|--------|---------|
| `parser` | YAML string → `ResourceDefinition` |
| `config_parser` | `shaperail.config.yaml` → `ProjectConfig` |
| `validator` | Semantic validation with human-readable errors |
| `openapi` | Resource definitions → OpenAPI 3.1 JSON/YAML |
| `typescript` | OpenAPI spec → TypeScript client SDK |

## Usage

```toml
[dependencies]
shaperail-codegen = "0.2"
```

```rust
use shaperail_codegen::parser::parse_resource;
use shaperail_codegen::validator::validate_resource;
use shaperail_codegen::openapi::generate_openapi;

let yaml = std::fs::read_to_string("resources/users.yaml")?;
let resource = parse_resource(&yaml)?;
let errors = validate_resource(&resource);
if errors.is_empty() {
    let spec = generate_openapi(&[resource]);
    println!("{}", serde_json::to_string_pretty(&spec)?);
}
```

## License

Dual-licensed under [MIT](../LICENSE-MIT) or [Apache-2.0](../LICENSE-APACHE).