Skip to content

Commit a2a4131

Browse files
committed
#1337 - List community-led media types in ref docs.
Include JSON:API and Siren implementations.
1 parent 1b000de commit a2a4131

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

src/main/asciidoc/mediatypes.adoc

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -633,6 +633,66 @@ Instead of linking each field "automatically" to a domain object's fields, you c
633633
to use Spring Framework's message bundles and the `MessageSource` interface. This gives you the ability to delegate these values to
634634
locale-specific message bundles and even internationalize the metadata.
635635

636+
[[mediatypes.community]]
637+
== Community-based media types
638+
639+
Thanks to the <<mediatypes.custom, ability to create your own media type>>, there are several community-led efforts to build additional media types.
640+
641+
[[mediatypes.community.json:api]]
642+
=== JSON:API
643+
644+
* https://jsonapi.org[Specification]
645+
* Media type designation: `application/vnd.api+json`
646+
* https://toedter.github.io/spring-hateoas-jsonapi[Reference documentation]
647+
* https://toedter.github.io/spring-hateoas-jsonapi/javadoc/index.html[javadocs]
648+
* https://github.com/toedter/spring-hateoas-jsonapi[Source]
649+
* Project Lead: https://github.com/toedter[Kai Toedter]
650+
651+
.Maven coordinates
652+
[source,xml,tabsize=2]
653+
----
654+
<dependency>
655+
<groupId>com.toedter</groupId>
656+
<artifactId>spring-hateoas-jsonapi</artifactId>
657+
<version>{see project page for current version}</version>
658+
</dependency>
659+
----
660+
661+
.Gradle coordinates
662+
[source,tabsize=2]
663+
----
664+
implementation 'com.toedter:spring-hateoas-jsonapi:{see project page for current version}'
665+
----
666+
667+
Visit the project page for more details if you want snapshot releases.
668+
669+
[[mediatypes.community.siren]]
670+
=== Siren
671+
672+
* https://github.com/kevinswiber/siren[Specification]
673+
* Media type designation: `application/vnd.siren+json`
674+
* https://spring-hateoas-siren.ingogriebsch.de[Reference documentation]
675+
* https://spring-hateoas-siren.ingogriebsch.de/apidocs[javadocs]
676+
* https://github.com/ingogriebsch/spring-hateoas-siren[Source]
677+
* Project Lead: https://github.com/ingogriebsch[Ingo Griebsch]
678+
679+
.Maven coordinates
680+
[source,xml,tabsize=2]
681+
----
682+
<dependency>
683+
<groupId>de.ingogriebsch.hateoas</groupId>
684+
<artifactId>spring-hateoas-siren</artifactId>
685+
<version>{see project page for current version}</version>
686+
<scope>compile</scope>
687+
</dependency>
688+
----
689+
690+
.Gradle coordinates
691+
[source,tabsize=2]
692+
----
693+
implementation 'de.ingogriebsch.hateoas:spring-hateoas-siren:{see project page for current version}'
694+
----
695+
636696
[[mediatypes.custom]]
637697
== Registering a custom media type
638698

0 commit comments

Comments
 (0)