json-api

Idiomatic types for building a robust JSON API.

Features

Serialization DSL

You can define a Resource using a friendly, declarative dsl.

Concise

```rust

[macro_use]

extern crate json_api;

struct Post { id: u64, body: String, title: String, author: Option, comments: Vec, }

resource!(Post, |&self| { // Define the id. id self.id;

// Define the resource "type"
kind "posts";

// Define attributes with a comma seperated list of field names.
attrs body, title;

// Define relationships with a comma seperated list of field names.
has_one author;
has_many comments;

}); ```

Flexible

```rust

[macro_use]

extern crate json_api;

struct Post { id: u64, body: String, title: String, author: Option, comments: Vec, }

resource!(Post, |&self| { kind "articles"; id self.id;

attrs body, title;

// Define a virtual attribute with an expression
attr "preview", {
    self.body
        .chars()
        .take(140)
        .collect::<String>()
}

// Define a relationship with granular detail
has_one "author", {
    // Data for has one should be Option<&T> where T: Resource
    data self.author.as_ref();

    // Define relationship links
    link "self", format!("/articles/{}/relationships/author", self.id);
    link "related", format!("/articles/{}/author", self.id);

    // Define arbitrary meta members with a block expression
    meta "read-only", true
}

// Define a relationship with granular detail
has_many "comments", {
    // Data for has one should be an Iterator<Item = &T> where T: Resource
    data self.comments.iter();

    // Define relationship links
    link "self", format!("/articles/{}/relationships/comments", self.id);
    link "related", format!("/articles/{}/comments", self.id);

    // Define arbitrary meta members with a block expression
    meta "total", {
        self.comments.len()
    }
}

// You can also define links with granular details as well
link "self", {
    href format!("/articles/{}", self.id);
}

// Define arbitrary meta members an expression
meta "copyright", self.author.as_ref().map(|user| {
    format!("© 2017 {}", user.full_name())
});

}); ```

Rocket Support

The json-api-rocket crate provides responders as well as a fairing for catching errors and returning JSON API error documents.

```rust

![feature(plugin)]

![plugin(rocket_codegen)]

[macro_use]

extern crate jsonapi; extern crate jsonapi_rocket; extern crate rocket;

mod models;

use jsonapirocket::JsonApiFairing; use jsonapirocket::response::{Collection, Member};

use models::Article;

[get("/")]

fn collection() -> Collection