Skip to content

Commit 775795a

Browse files
iwaltgeniwaltgen
authored
feat: apply @Min @Max constraints to NumberSchema (#199)
1 parent 27db748 commit 775795a

4 files changed

Lines changed: 151 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,9 @@ Currently the following constraints are considered when generating JsonSchema fr
253253
- for String fields annotated with `NotEmpty`, and `NotBlank` the `minLength` constraint in JsonSchema is set to 1
254254
- for String fields annotated with `Length` the `minLength` and `maxLength` constraints in JsonSchema are set to the value of the corresponding attribute of the annotation
255255
- for String fields annotated with `Pattern`, the pattern constraint is propagated to JsonSchema
256+
- for Number fields annotated with `Min`, the `minimum` constraint is propagated to JsonSchema
257+
- for Number fields annotated with `Max`, the `maximum` constraint is propagated to JsonSchema
258+
- for Number fields annotated with `Size` the `minimum` and `maximum` constraints in JsonSchema are set to the value of the corresponding attribute of the annotation
256259

257260
If you already have your own `ConstraintFields` implementation you can also add the logic from `com.epages.restdocs.apispec.ConstrainedFields` to your own class.
258261
Here it is important to add the constraints under the key `validationConstraints` into the attributes map if the `FieldDescriptor`.

‎restdocs-api-spec-jsonschema/src/main/kotlin/com/epages/restdocs/apispec/jsonschema/ConstraintResolver.kt‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ internal object ConstraintResolver {
2626

2727
private const val PATTERN_CONSTRAINT = "javax.validation.constraints.Pattern"
2828

29+
private const val MIN_CONSTRAINT = "javax.validation.constraints.Min"
30+
31+
private const val MAX_CONSTRAINT = "javax.validation.constraints.Max"
32+
2933
internal fun maybeMinSizeArray(fieldDescriptor: FieldDescriptor?) = fieldDescriptor?.maybeSizeConstraint()?.let { it.configuration["min"] as? Int }
3034

3135
internal fun maybeMaxSizeArray(fieldDescriptor: FieldDescriptor?) = fieldDescriptor?.maybeSizeConstraint()?.let { it.configuration["max"] as? Int }
@@ -54,6 +58,30 @@ internal object ConstraintResolver {
5458
?.let { it.configuration["max"] as Int }
5559
}
5660

61+
internal fun minInteger(fieldDescriptor: FieldDescriptor): Int? {
62+
return findConstraints(fieldDescriptor)
63+
.mapNotNull {
64+
when (it.name) {
65+
MIN_CONSTRAINT -> it.configuration["value"] as Int
66+
SIZE_CONSTRAINT -> it.configuration["min"] as? Int
67+
else -> null
68+
}
69+
}
70+
.maxOrNull()
71+
}
72+
73+
internal fun maxInteger(fieldDescriptor: FieldDescriptor): Int? {
74+
return findConstraints(fieldDescriptor)
75+
.mapNotNull {
76+
when (it.name) {
77+
MAX_CONSTRAINT -> it.configuration["value"] as Int
78+
SIZE_CONSTRAINT -> it.configuration["max"] as? Int
79+
else -> null
80+
}
81+
}
82+
.minOrNull()
83+
}
84+
5785
internal fun isRequired(fieldDescriptor: FieldDescriptor): Boolean =
5886
findConstraints(fieldDescriptor)
5987
.any { constraint -> REQUIRED_CONSTRAINTS.contains(constraint.name) }

‎restdocs-api-spec-jsonschema/src/main/kotlin/com/epages/restdocs/apispec/jsonschema/JsonSchemaFromFieldDescriptorsGenerator.kt‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
package com.epages.restdocs.apispec.jsonschema
22

33
import com.epages.restdocs.apispec.jsonschema.ConstraintResolver.isRequired
4+
import com.epages.restdocs.apispec.jsonschema.ConstraintResolver.maxInteger
45
import com.epages.restdocs.apispec.jsonschema.ConstraintResolver.maxLengthString
56
import com.epages.restdocs.apispec.jsonschema.ConstraintResolver.maybeMaxSizeArray
67
import com.epages.restdocs.apispec.jsonschema.ConstraintResolver.maybeMinSizeArray
78
import com.epages.restdocs.apispec.jsonschema.ConstraintResolver.maybePattern
9+
import com.epages.restdocs.apispec.jsonschema.ConstraintResolver.minInteger
810
import com.epages.restdocs.apispec.jsonschema.ConstraintResolver.minLengthString
911
import com.epages.restdocs.apispec.model.Attributes
1012
import com.epages.restdocs.apispec.model.FieldDescriptor
@@ -233,7 +235,7 @@ class JsonSchemaFromFieldDescriptorsGenerator {
233235
"object" -> ObjectSchema.builder()
234236
"array" -> ArraySchema.builder().applyConstraints(this).allItemSchema(arrayItemsSchema())
235237
"boolean" -> BooleanSchema.builder()
236-
"number" -> NumberSchema.builder()
238+
"number" -> NumberSchema.builder().applyConstraints(this)
237239
"string" -> StringSchema.builder().applyConstraints(this)
238240
"enum" -> CombinedSchema.oneOf(
239241
listOf(
@@ -291,3 +293,14 @@ private fun ArraySchema.Builder.applyConstraints(fieldDescriptor: FieldDescripto
291293
minItems(maybeMinSizeArray(fieldDescriptor))
292294
maxItems(maybeMaxSizeArray(fieldDescriptor))
293295
}
296+
297+
private fun NumberSchema.Builder.applyConstraints(fieldDescriptor: FieldDescriptor) = apply {
298+
minInteger(fieldDescriptor)?.let {
299+
minimum(it)
300+
requiresInteger(true)
301+
}
302+
maxInteger(fieldDescriptor)?.let {
303+
maximum(it)
304+
requiresInteger(true)
305+
}
306+
}

‎restdocs-api-spec-jsonschema/src/test/kotlin/com/epages/restdocs/apispec/jsonschema/JsonSchemaFromFieldDescriptorsGeneratorTest.kt‎

Lines changed: 106 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ import org.json.JSONObject
2424
import org.junit.jupiter.api.Test
2525
import java.io.IOException
2626
import java.util.Collections.emptyMap
27+
import javax.validation.constraints.Max
28+
import javax.validation.constraints.Min
2729
import javax.validation.constraints.NotNull
30+
import javax.validation.constraints.Size
2831

2932
class JsonSchemaFromFieldDescriptorsGeneratorTest {
3033

@@ -97,6 +100,34 @@ class JsonSchemaFromFieldDescriptorsGeneratorTest {
97100
then(lineItemsTaxesSchema.maxItems).isEqualTo(255)
98101
then(lineItemsTaxesSchema.requiresArray()).isTrue()
99102

103+
then(objectSchema.definesProperty("pageIndex")).isTrue
104+
then(objectSchema.propertySchemas["pageIndex"]).isInstanceOf(NumberSchema::class.java)
105+
val pageIndexSchema = objectSchema.propertySchemas["pageIndex"] as NumberSchema
106+
then(pageIndexSchema.minimum.toInt()).isEqualTo(1)
107+
then(pageIndexSchema.maximum.toInt()).isEqualTo(100)
108+
then(pageIndexSchema.requiresInteger()).isTrue
109+
110+
then(objectSchema.definesProperty("pageSize")).isTrue
111+
then(objectSchema.propertySchemas["pageSize"]).isInstanceOf(NumberSchema::class.java)
112+
val pageSizeSchema = objectSchema.propertySchemas["pageSize"] as NumberSchema
113+
then(pageSizeSchema.minimum.toInt()).isEqualTo(1)
114+
then(pageSizeSchema.maximum.toInt()).isEqualTo(255)
115+
then(pageSizeSchema.requiresInteger()).isTrue
116+
117+
then(objectSchema.definesProperty("pagePositive")).isTrue
118+
then(objectSchema.propertySchemas["pagePositive"]).isInstanceOf(NumberSchema::class.java)
119+
val pagePositiveSchema = objectSchema.propertySchemas["pagePositive"] as NumberSchema
120+
then(pagePositiveSchema.minimum.toInt()).isEqualTo(1)
121+
then(pagePositiveSchema.maximum).isNull()
122+
then(pagePositiveSchema.requiresInteger()).isTrue
123+
124+
then(objectSchema.definesProperty("page100_200")).isTrue
125+
then(objectSchema.propertySchemas["page100_200"]).isInstanceOf(NumberSchema::class.java)
126+
val page100to200Schema = objectSchema.propertySchemas["page100_200"] as NumberSchema
127+
then(page100to200Schema.minimum.toInt()).isEqualTo(100)
128+
then(page100to200Schema.maximum.toInt()).isEqualTo(200)
129+
then(page100to200Schema.requiresInteger()).isTrue
130+
100131
// language=JSON
101132
thenSchemaValidatesJson(
102133
"""{
@@ -122,7 +153,11 @@ class JsonSchemaFromFieldDescriptorsGeneratorTest {
122153
}
123154
]
124155
},
125-
"pattern": "a"
156+
"pattern": "a",
157+
"pageIndex": 1,
158+
"pageSize": 255,
159+
"pageHalf": 100,
160+
"page100_200": 200
126161
}
127162
""".trimIndent()
128163
)
@@ -659,6 +694,76 @@ class JsonSchemaFromFieldDescriptorsGeneratorTest {
659694
"some",
660695
"STRING",
661696
attributes = patternConstraint
697+
),
698+
FieldDescriptor(
699+
"pageIndex",
700+
"some",
701+
"NUMBER",
702+
attributes = Attributes(
703+
listOf(
704+
Constraint(
705+
Min::class.java.name,
706+
mapOf("value" to 1)
707+
),
708+
Constraint(
709+
Max::class.java.name,
710+
mapOf("value" to 100)
711+
)
712+
)
713+
)
714+
),
715+
FieldDescriptor(
716+
"pageSize",
717+
"some",
718+
"NUMBER",
719+
attributes = Attributes(
720+
listOf(
721+
Constraint(
722+
Size::class.java.name,
723+
mapOf(
724+
"min" to 1,
725+
"max" to 255
726+
)
727+
)
728+
)
729+
)
730+
),
731+
FieldDescriptor(
732+
"pagePositive",
733+
"some",
734+
"NUMBER",
735+
attributes = Attributes(
736+
listOf(
737+
Constraint(
738+
Size::class.java.name,
739+
mapOf("min" to 1)
740+
)
741+
)
742+
)
743+
),
744+
FieldDescriptor(
745+
"page100_200",
746+
"some",
747+
"NUMBER",
748+
attributes = Attributes(
749+
listOf(
750+
Constraint(
751+
Size::class.java.name,
752+
mapOf(
753+
"min" to 1,
754+
"max" to 255
755+
)
756+
),
757+
Constraint(
758+
Min::class.java.name,
759+
mapOf("value" to 100)
760+
),
761+
Constraint(
762+
Max::class.java.name,
763+
mapOf("value" to 200)
764+
)
765+
)
766+
)
662767
)
663768
)
664769
}

0 commit comments

Comments
 (0)