Struct ApiDocsRenderer 

pub struct ApiDocsRenderer { /* private fields */ }

Renders markdown API documentation from a schema, one page per type.

Implementations

impl ApiDocsRenderer

pub fn new(options: ApiDocsOptions) -> Self

pub fn generate_all<P: AsRef<Path>>( &mut self, generator: &SchemaGenerator, output_dir: P, ) -> Result<()>

Render a page for every schema in the generator into the directory, each named after its type with the file_extension option, along with the index page. Every schema is known to every page, so references link to each other the same as they do through SchemaGenerator::generate.

pub fn render_index_page( &mut self, schemas: &IndexMap<String, Schema>, ) -> RenderResult

Render the index page, a table of every schema in name order that links to its page, with its kind and the first paragraph of its description.

Trait Implementations

impl Default for ApiDocsRenderer

fn default() -> Self

Returns the “default value” for a type.

impl SchemaRenderer<TypeExpression> for ApiDocsRenderer

fn is_reference(&self, name: &str) -> bool

Return true of the provided name is a referenced type.

fn render_array( &mut self, array: &ArrayType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render an ArrayType to a string.

fn render_boolean( &mut self, _boolean: &BooleanType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a boolean type to a string.

fn render_enum( &mut self, enu: &EnumType, schema: &Schema, ) -> RenderResult<TypeExpression>

Render an EnumType to a string.

fn render_float( &mut self, _float: &FloatType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a FloatType to a string.

fn render_integer( &mut self, _integer: &IntegerType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render an IntegerType to a string.

fn render_literal( &mut self, literal: &LiteralType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a LiteralType to a string.

fn render_null(&mut self, _schema: &Schema) -> RenderResult<TypeExpression>

Render a null type to a string.

fn render_object( &mut self, object: &ObjectType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render an ObjectType to a string.

fn render_reference( &mut self, reference: &str, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a referenced type to a string.

fn render_string( &mut self, _string: &StringType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a StringType to a string.

fn render_struct( &mut self, structure: &StructType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a StructType to a string.

fn render_tuple( &mut self, tuple: &TupleType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a TupleType to a string.

fn render_union( &mut self, uni: &UnionType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a UnionType to a string.

fn render_unknown(&mut self, _schema: &Schema) -> RenderResult<TypeExpression>

Render an unknown type to a string.

fn render(&mut self, schemas: IndexMap<String, Schema>) -> RenderResult

Render the list of Schemas to a string, in the order they are listed. References between types can be resolved using the provided schemas map.

fn render_schema(&mut self, schema: &Schema) -> RenderResult<O>

Render all possible variants of the provided Schema to a string. If a variant has an explicit name, and that name is a reference, return the name instead of rendering the type.

fn render_schema_without_reference( &mut self, schema: &Schema, ) -> RenderResult<O>

Like Self::render_schema but does not check for references.