com.cerner.beadledom.avro

Class SwaggerAvroModelConverter

java.lang.Object

com.wordnik.swagger.converter.SwaggerSchemaConverter

com.cerner.beadledom.avro.SwaggerAvroModelConverter

All Implemented Interfaces:

com.wordnik.swagger.converter.BaseConverter, com.wordnik.swagger.converter.ModelConverter

public class SwaggerAvroModelConverter
extends com.wordnik.swagger.converter.SwaggerSchemaConverter

This produces Swagger model schemas for Avro generated classes, by looking at the Avro schema (rather than by inspecting the Java class for members and annotations).

This will only attempt to process classes which derive from SpecificRecordBase and contain a static field named SCHEMA$ which is an instance of Schema. The default Avro code generator for Java produces such classes. If you need to handle other classes, override getSchema(Class).

All of the following are currently unsupported and will result in omitted fields:

• schema type 'fixed'
• maps
• unions, except unions of 'null' with one other type
• nested collections such as array<array<string>> are unsupported, you can of course have a collection inside a record inside a collection

Unions of 'null' and one other type will be treated as optional fields; all other fields will be assumed required.

Avro fields of type 'bytes' are represented as Swagger properties of type 'string', format 'byte'.

By default, field names are converted to snake case. You can override the getFieldName(Schema.Field) method to change this.

To accommodate javadoc-style comments in avdl files, by default, if a line of a model/field description begins with whitespace followed by an asterisk, those characters (along with one subsequent whitespace character) will be removed. You can override the adjustDescription(String) method to change this.

Constructor Summary

Constructors

Constructor and Description
SwaggerAvroModelConverter()

Method Summary

Modifier and Type	Method and Description
protected String	adjustDescription(String doc) Given the doc string for an Avro entity, return the Swagger description to use.
protected String	getFieldName(org.apache.avro.Schema.Field field) Given an Avro field, return the name that should be used for the Swagger property.
protected String	getName(org.apache.avro.Schema schema)
protected org.apache.avro.Schema	getSchema(Class<?> cls) Return the Avro schema for the given class, or null if this converter should not handle this class.
protected com.wordnik.swagger.model.ModelProperty	parseField(org.apache.avro.Schema.Field field) Generate a ModelProperty for the given field.
protected com.wordnik.swagger.model.ModelProperty	parseSchema(org.apache.avro.Schema schema) Generate a ModelProperty for the given schema.
scala.Option<com.wordnik.swagger.model.Model>	read(Class<?> cls, scala.collection.immutable.Map<String,String> typeMap)
scala.Option<String>	toDescriptionOpt(Class<?> cls)
String	toName(Class<?> cls)

Methods inherited from class com.wordnik.swagger.converter.SwaggerSchemaConverter

ignoredClasses, ignoredPackages, skippedClasses, typeMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SwaggerAvroModelConverter

public SwaggerAvroModelConverter()

Method Detail

read

public scala.Option<com.wordnik.swagger.model.Model> read(Class<?> cls,
                                                          scala.collection.immutable.Map<String,String> typeMap)

Specified by:

read in interface com.wordnik.swagger.converter.ModelConverter

Overrides:

read in class com.wordnik.swagger.converter.SwaggerSchemaConverter

toName

public String toName(Class<?> cls)

Specified by:

toName in interface com.wordnik.swagger.converter.BaseConverter

Specified by:

toName in interface com.wordnik.swagger.converter.ModelConverter

Overrides:

toName in class com.wordnik.swagger.converter.SwaggerSchemaConverter

toDescriptionOpt

public scala.Option<String> toDescriptionOpt(Class<?> cls)

Specified by:

toDescriptionOpt in interface com.wordnik.swagger.converter.BaseConverter

Specified by:

toDescriptionOpt in interface com.wordnik.swagger.converter.ModelConverter

Overrides:

toDescriptionOpt in class com.wordnik.swagger.converter.SwaggerSchemaConverter

getName

protected String getName(org.apache.avro.Schema schema)

parseSchema

@Nullable
protected com.wordnik.swagger.model.ModelProperty parseSchema(org.apache.avro.Schema schema)

Generate a ModelProperty for the given schema.

This is used by parseField(Schema.Field), which is responsible for overriding the parts of the ModelProperty (such as position and description) that cannot be determined merely by looking at the schema. It may also be used recursively to build collection and union types.

Returns:

the parsed property, or null if it cannot/should not be represented in the Swagger model

parseField

@Nullable
protected com.wordnik.swagger.model.ModelProperty parseField(org.apache.avro.Schema.Field field)

Generate a ModelProperty for the given field.

Returns:

the parsed property, or null if the property should be excluded from the Swagger model

getSchema

@Nullable
protected org.apache.avro.Schema getSchema(Class<?> cls)

Return the Avro schema for the given class, or null if this converter should not handle this class.

getFieldName

protected String getFieldName(org.apache.avro.Schema.Field field)

Given an Avro field, return the name that should be used for the Swagger property.

adjustDescription

@Nullable
protected String adjustDescription(@Nullable
                                             String doc)

Given the doc string for an Avro entity, return the Swagger description to use.

Parameters:

doc - the avro doc string to adjust (may be null)

Returns:

the adjusted documentation, or null