XCribe v0.5.0 API Reference

Modules

This is the documentation for the XCribe Project

Handle Xcribe configurations.

Used to convert a Plug.Conn to a Xcribe.Request.

Used to decode requests content to an elixir collection (map, list, etc)

This module implements a set of useful functions for formatter modules.

Wrapper for a JSON library.

The struct of a parsed request

Treats list of Requests and generates OpenAPI Document with json format

Format a given Xcribe.Request according to OpenAPI Specification.

Handle primitive data types.

Writes the documentation to an file on the project.

Exceptions

Raised at runtime when can't decode an unknown content type.

Raised at runtime when not configured an implementation of Xcribe.Information.

Raised at runtime when configured format is unknown.