From f1e1c5e5213f76cd8fdd2c1eaec1a7f6260d09bc Mon Sep 17 00:00:00 2001 From: Dominic Date: Sun, 22 Nov 2020 23:56:25 +0100 Subject: [PATCH] update readme --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 643174c..99cf632 100644 --- a/README.md +++ b/README.md @@ -34,12 +34,20 @@ This crate is an extension to the popular [gotham web framework][gotham] for Rus create resources with assigned methods that aim to be a more convenient way of creating handlers for requests. -## Design Goals +## Features -This is an opinionated framework on top of [gotham]. Unless your web server handles mostly JSON as -request/response bodies and does that in a RESTful way, this framework is probably a bad fit for -your application. The ultimate goal of gotham-restful is to provide a way to write a RESTful -web server in Rust as convenient as possible with the least amount of boilerplate neccessary. + - Automatically parse **JSON** request and produce response bodies + - Allow using **raw** request and response bodies + - Convenient **macros** to create responses that can be registered with gotham's router + - Auto-Generate an **OpenAPI** specification for your API + - Manage **CORS** headers so you don't have to + - Manage **Authentication** with JWT + - Integrate diesel connection pools for easy **database** integration + +## Safety + +This crate is just as safe as you'd expect from anything written in safe Rust - and +`#![forbid(unsafe_code)]` ensures that no unsafe was used. ## Methods