Allow deriving MakeSchema on simple structs!

This commit is contained in:
Graham Esau 2019-08-04 16:44:09 +01:00
parent fcb9d5d1c0
commit 5228ec65e5
9 changed files with 90 additions and 38 deletions

View file

@ -9,3 +9,4 @@ edition = "2018"
[dependencies]
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
schemars_derive = { version = "0.1.0", path = "../schemars_derive" }

View file

@ -76,7 +76,6 @@ impl SchemaGenerator {
fn make_unique_name<T: ?Sized + MakeSchema>(&mut self) -> String {
let base_name = T::schema_name();
// TODO remove namespace, remove special chars
if self.names.contains(&base_name) {
for i in 2.. {
let name = format!("{}{}", base_name, i);

View file

@ -1,11 +1,8 @@
pub mod generator;
pub mod make_schema;
pub mod schema;
pub mod generator;
#[cfg(test)]
mod tests {
#[test]
fn it_works() {
assert_eq!(2 + 2, 4);
}
}
pub use generator::SchemaGenerator;
pub use schema::{Schema, SchemaObject, SchemaRef};
pub use schemars_derive::*;

View file

@ -1,9 +1,4 @@
pub mod generator;
pub mod make_schema;
pub mod schema;
use make_schema::MakeSchema;
use schema::*;
use schemars::MakeSchema;
use serde::{Deserialize, Serialize};
use serde_json::Result;
@ -16,43 +11,26 @@ enum TodoStatus {
Archived,
}
#[derive(Serialize, Deserialize, Debug)]
#[derive(Serialize, Deserialize, Debug, MakeSchema)]
#[serde(rename_all = "camelCase")]
struct Todo {
id: u64,
title: String,
description: Option<String>,
status: TodoStatus,
// status: TodoStatus,
assigned_to: Vec<User>,
}
#[derive(Serialize, Deserialize, Debug)]
#[derive(Serialize, Deserialize, Debug, MakeSchema)]
#[serde(rename_all = "camelCase")]
struct User {
id: u64,
username: String,
}
impl MakeSchema for User {
fn generates_ref_schema() -> bool {
true
}
fn make_schema(gen: &mut generator::SchemaGenerator) -> Schema {
let mut o = SchemaObject {
..Default::default()
};
o.properties
.insert("id".to_owned(), gen.subschema_for::<u64>());
o.properties
.insert("username".to_owned(), gen.subschema_for::<String>());
o.into()
}
}
fn main() -> Result<()> {
let gen = generator::SchemaGenerator::new();
let schema = gen.into_root_schema_for::<User>();
let gen = schemars::SchemaGenerator::new();
let schema = gen.into_root_schema_for::<Todo>();
let json = serde_json::to_string_pretty(&schema)?;
println!("{}", json);

View file

@ -17,7 +17,7 @@ pub trait MakeSchema {
// It's probably worth removing the default implemenation,
// then make every impl in this file set an explicit name
// Or maybe hide it under feature flag?
core::any::type_name::<Self>().to_owned()
core::any::type_name::<Self>().replace(|c: char| !c.is_ascii_alphanumeric(), "_")
}
fn generates_ref_schema() -> bool {

View file

@ -2,6 +2,8 @@ use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::collections::BTreeMap as Map;
// TODO use serde_json::Map (or some other wrapper) instead of BTreeMap to ensure preserve_order is possible
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
#[serde(untagged)]
pub enum Schema {