Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnstonskj/rust-atelier
Rust native core model for the AWS Smithy IDL
https://github.com/johnstonskj/rust-atelier
idl rust smithy
Last synced: 14 days ago
JSON representation
Rust native core model for the AWS Smithy IDL
- Host: GitHub
- URL: https://github.com/johnstonskj/rust-atelier
- Owner: johnstonskj
- License: mit
- Created: 2020-06-17T15:54:46.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-31T00:57:25.000Z (over 1 year ago)
- Last Synced: 2024-10-10T23:33:34.457Z (30 days ago)
- Topics: idl, rust, smithy
- Language: Rust
- Homepage:
- Size: 3.06 MB
- Stars: 76
- Watchers: 5
- Forks: 11
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-smithy - Atelier - Community implementation of Smithy in Rust (Implementations / Server Code Generators)
README
# The _Atelier_ Project
Rust native library and tools for the AWS [Smithy](https://github.com/awslabs/smithy) Interface Definition Language.
[](https://github.com/johnstonskj/rust-atelier/stargazers)
[](https://gitpod.io/#https://github.com/johnstonskj/rust-atelier)
Smithy is a framework around a language and runtime neutral IDL for service definition. It consists of a semantic model,
a native IDL representation, and a mapping to JSON. The goal of this work is to replicate these core components of
Smithy in Rust but also to experiment in alternate integrations such as the representation of the semantic model in
RDF. This work should provide the basis for Rust code generation from a Smithy model and other tooling opportunities,
but those are not included in this repo.
**The Name "Atelier"**
Given that a Smithy is "_the workshop of a smith_", this project has been named for "_an artist's or designer's studio or
workroom_". Also, given that Fashion Tech. is just a damn fun place to be these days, it seemed appropriate.
## Crates
This repo contains a number of crates that provide different aspects, or capabilities, around Smithy processing. For
clients that wish to use a number of features but don't want to track individual version compatibility the `atelier_lib`
crate incorporates all, except the cargo command, using features to select the different capabilities.
| crate | Content | Status |
|--------------------------------------------|--------------------------------------------------------|----------------------------------------|
| [`atelier_core`](./atelier-core) | The Model, Builder, and Selector types and I/O traits. | Model: Done, Builder: Done, Tests: OK |
| [`atelier_assembler`](./atelier-assembler) | merge files into a single in-memory Model. | Model: Done, Tests: Low |
| [`atelier_describe`](./atelier-describe) | Model documentation writer, uses `somedoc` crate. | Writer: 75%, Tests: Low |
| [`atelier_json`](./atelier-json) | The serializer/de-serializer for the JSON AST. | Reader/Writer: Done, Tests: Low |
| [`atelier_lib`](./atelier-lib) | Re-export structures from previous crates. | Done. |
| [`atelier_openapi`](./atelier-openapi) | A Serializer only to OpenAPI. | Not Started |
| [`atelier_query`](./atelier-query) | Evaluator for Smithy select expressions. | Not Started |
| [`atelier_rdf`](./atelier-rdf) | The serializer/de-serializer to RDF. | Model: Done, Writer: Done, Tests: Low |
| [`atelier_smithy`](./atelier-smithy) | The serializer/de-serializer for native Smithy. | Reader/Writer: Done, Tests: Low |
| [`cargo_atelier`](./cargo-atelier) | Cargo command to lint, validate, and convert models. | Commands working correctly. |
## Book
This repo also contains the source (using [mdbook](https://rust-lang.github.io/mdBook/)) of a more complete documentation
set. This is built using GitHub pages and accessible at [rust-atelier.dev](https://rust-atelier.dev/).
## Changes
See individual crate README files.