Package com.github.victools.jsonschema.module.swagger15

Class SwaggerModule

  • All Implemented Interfaces:
    Module
    public class SwaggerModule
extends Object
implements Module
    JSON Schema Generator Module – Swagger (1.5).

    • Constructor Detail

      • SwaggerModule

        public SwaggerModule​(SwaggerOption... options)
        Constructor.
        Parameters:
        options - features to enable

    • Method Detail

      • shouldIgnore

        protected boolean shouldIgnore​(MemberScope<?,​?> member)
        Determine whether a given member should be ignored, i.e. excluded from the generated schema.
        Parameters:
        member - targeted field/method
        Returns:
        whether to ignore the given field/method

      • resolvePropertyNameOverride

        protected String resolvePropertyNameOverride​(FieldScope field)
        Look-up name override for a given field or its associated getter method from the ApiModelProperty annotation's name.
        Parameters:
        field - targeted field
        Returns:
        applicable name override (or null)

      • resolveDescription

        protected String resolveDescription​(MemberScope<?,​?> member)
        Look-up a "description" for the given member or its associated getter/field from the ApiModelProperty annotation's value.
        Parameters:
        member - targeted field/method
        Returns:
        description (or null)

      • resolveDescriptionForType

        protected String resolveDescriptionForType​(TypeScope scope)
        Look-up a "description" from the given type's ApiModel annotation's description.
        Parameters:
        scope - targeted type
        Returns:
        description (or null)

      • resolveTitleForType

        protected String resolveTitleForType​(TypeScope scope)
        Look-up a "title" for the given member or its associated getter/field from the member type's ApiModel annotation's value.
        Parameters:
        scope - targeted type
        Returns:
        title (or null)

      • resolveAllowedValues

        protected List<String> resolveAllowedValues​(MemberScope<?,​?> member)
        Look-up a "const"/"enum" for the given member or its associated getter/field from the ApiModelProperty annotation's allowedValues.
        Parameters:
        member - targeted field/method
        Returns:
        list of allowed values (or null)

      • resolveNumberInclusiveMinimum

        protected BigDecimal resolveNumberInclusiveMinimum​(MemberScope<?,​?> member)
        Determine (inclusive) numeric minimum for the given member or its associated getter/field from the ApiModelProperty annotation's allowedValues.
        Parameters:
        member - targeted field/method
        Returns:
        inclusive numeric minimum (or null)

      • resolveNumberExclusiveMinimum

        protected BigDecimal resolveNumberExclusiveMinimum​(MemberScope<?,​?> member)
        Determine (exclusive) numeric minimum for the given member or its associated getter/field from the ApiModelProperty annotation's allowedValues.
        Parameters:
        member - targeted field/method
        Returns:
        exclusive numeric minimum (or null)

      • resolveNumberInclusiveMaximum

        protected BigDecimal resolveNumberInclusiveMaximum​(MemberScope<?,​?> member)
        Determine (inclusive) numeric maximum for the given member or its associated getter/field from the ApiModelProperty's annotation's allowedValues.
        Parameters:
        member - targeted field/method
        Returns:
        inclusive numeric maximum (or null)

      • resolveNumberExclusiveMaximum

        protected BigDecimal resolveNumberExclusiveMaximum​(MemberScope<?,​?> member)
        Determine (exclusive) numeric maximum for the given member or its associated getter/field from the ApiModelProperty's annotation's allowedValues.
        Parameters:
        member - targeted field/method
        Returns:
        exclusive numeric maximum (or null)