Spring/spring-hateoas
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#1364 - Document recommended visibility of media type configuration classes.

Browse Source
This commit is contained in:
Oliver Drotbohm
2020-09-14 22:04:06 +02:00
parent 6982fc30a7
commit b8d9a15e67
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/main/asciidoc/mediatypes.adoc
View File

@@ -722,7 +722,7 @@ To define your own media type could look as simple as this:
[source, java]
----
@Configuration
class MyMediaTypeConfiguration implements HypermediaMappingInformation {
public class MyMediaTypeConfiguration implements HypermediaMappingInformation {
@Override
public List<MediaType> getMediaTypes() {
@@ -764,3 +764,6 @@ In the `Serializer` and `Deserializer` implementations registered for `Represent
The media types supported by default use the same configuration mechanism as third-party implementations would do.
So it's worth studying the implementations in https://github.com/spring-projects/spring-hateoas/tree/master/src/main/java/org/springframework/hateoas/mediatype[the `mediatype` package].
Note, that the built in media type implementations keep their configuration classes package private, as they're activated via `@EnableHypermediaSupport`.
Custom implementations should probably make those public instead to make sure, users can import those configuration classes from their application packages.