[−][src]Crate http_api_problem

HTTP-API-PROBLEM

A library to create HTTP response content for APIs based on RFC7807.

** Breaking changes! This crate now uses http::StatusCode instead of the own custom one **

Usage

Get the latest version for your Cargo.toml from crates.io.

Add this to your crate root:

extern crate http_api_problem;

serde

HttpApiProblem implements Serialize and Deserialize for HttpApiProblem.

Examples

use http_api_problem::*;

let p = HttpApiProblem::with_title_and_type_from_status(StatusCode::NOT_FOUND)
    .set_detail("detailed explanation")
    .set_instance("/on/1234/do/something");

assert_eq!(Some("https://httpstatuses.com/404".to_string()), p.type_url);
assert_eq!(Some(StatusCode::NOT_FOUND), p.status);
assert_eq!("Not Found".to_string(), p.title);
assert_eq!(Some("detailed explanation".to_string()), p.detail);
assert_eq!(Some("/on/1234/do/something".to_string()), p.instance);

There is also From<u16> implemented for StatusCode:

use http_api_problem::*;

let p = HttpApiProblem::with_title_and_type_from_status(StatusCode::PRECONDITION_REQUIRED)
    .set_detail("detailed explanation")
    .set_instance("/on/1234/do/something");

assert_eq!(Some("https://httpstatuses.com/428".to_string()), p.type_url);
assert_eq!(Some(StatusCode::PRECONDITION_REQUIRED), p.status);
assert_eq!("Precondition Required".to_string(), p.title);
assert_eq!(Some("detailed explanation".to_string()), p.detail);
assert_eq!(Some("/on/1234/do/something".to_string()), p.instance);

Features

with_iron

There is a conversion between irons StatusCode and StatusCode back and forth.

The HttpApiProblem provides a method to_iron_response which constructs an iron Response. If the status field of the HttpApiProblem is None 500 - Internal Server Error is the default.

From<HttpApiProblem for iron::response::Response will also be there. It simply calls to_iron_response.

Additionally there will be a function into_iron_response which converts anything into an iron::response::Response that can be converted into a HttpApiProblem.

with_hyper

There is a conversion between hyperss StatusCode and StatusCode back and forth.

The HttpApiProblem provides a method to_hyper_response which constructs a hyper Response. If the status field of the HttpApiProblem is None 500 - Internal Server Error is the default.

From<HttpApiProblem for hyper::Response will also be there. It simply calls to_hyper_response.

Additionally there will be a function into_iron_response which converts anything into a hyper::Response that can be converted into a HttpApiProblem.

HttpApiProblem	Description of a problem that can be returned by an HTTP API based on RFC7807
StatusCode	An HTTP status code (`status-code` in RFC 7230 et al.).

Statics

PROBLEM_JSON_MEDIA_TYPE

The recommended media type when serialized to JSON

Traits

HttpTryFrom

Private trait for the http crate to have generic methods with fallible conversions.