Skip to content

Commit fbfdbe7

Browse files
committed
Stated goals of this project
Especially in regards to the use of annotations for documentation fixes springfox#1231
1 parent 9fecb5b commit fbfdbe7

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

docs/asciidoc/introduction.adoc

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,16 @@ _swagger-springmvc_. Much kudos goes to Marty.
1212

1313
=== Goals
1414

15-
. To extend support for a number of the evolving standards targeted at JSON API specification and documentation
16-
such
17-
as: http://swagger.io/[swagger], http://raml.org/[RAML] and http://jsonapi.org/[jsonapi].
15+
- To extend support for a number of the evolving standards targeted at JSON API specification and documentation
16+
such as: http://swagger.io/[swagger], http://raml.org/[RAML] and http://jsonapi.org/[jsonapi].
1817

19-
. To extend support for spring technologies other than
20-
http://docs.spring.io/spring/docs/current/spring-framework-reference/html/mvc.html[spring webmvc]
18+
- To extend support for spring technologies other than http://docs.spring.io/spring/docs/current/spring-framework-reference/html/mvc.html[spring webmvc]
19+
20+
- Philosophically, we want to discourage using (swagger-core) annotations that are not material to the
21+
service description at runtime. For e.g. the jackson annotations should always trump or have more weight than
22+
`@ApiModelProperty` or for e.g. `@NotNull` or specifying @RequestParam#required should always win. Annotations are to
23+
to be used only to supplement documentation or override/tweak the resulting spec in cases where its not possible to
24+
infer service/schema characteristics.
2125

2226
=== What it's not
2327

0 commit comments

Comments
 (0)