Download the PHP package kmfk/hateoas-bundle without Composer
On this page you can find all versions of the php package kmfk/hateoas-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package hateoas-bundle
Hateoas Bundle
While this works as a simple, drop in bundle for Symfony, you can find a much more full featured library and bundle here:
Overview
The Hateoas Bundle works with JMS Serializer to allow you to easily add Hateoas compliant resource urls to the JSON output of your REST Api.
There are other similar bundles, but they seemed heavy for my needs. This bundle was designed to work seamlessly with JMS Serializer, with out needing to abstract or obfuscate the serialization of your data.
Currently this bundle only provides Annotations for Resource Linking in your Serialized response.
Hateoas Bundle Installation
The best method of installation is through the use of composer.
Add the bundle to Composer
Update AppKernel.php
Add The Hateoas Bundle to your kernel bootstrap sequence
Configure the Bundle
The bundle allows you to configure the Rest API host and an optional Path prefix. Your links will be built using these values. If they are not set, the bundle will default to parsing this from the current request.
Annotations
Once configured, you can use the Annotations provided by this bundle to easily add resource links to your classes and properties.
Output:
Annotation Reference
| Property | Description | Example |
|---|---|---|
name |
The property name inside the 'links' attribute | user |
href |
The relative (path) url of the resource, including url tokens | /user/{id}/ |
params |
An associative array of token names with their corresponding getter methods | { "id" = "getId" } |
groups |
Serializer Groups, Used the same way as JMS Serializer Groups | { "partial", "full" } |
type |
'Absolute' or 'Embedded' | absolute |
Using Params
You can have multiple tokens in the href. The params array should be an associative array
with keys matching the tokens in the path. Methods listed should be methods that exist in the
annotated class.
Groups
Specifying groups allow you to control the output of the links based on
Exclusion Groups
Embedded vs Absolute Links
While absolute (default value), will allows include the API Host and optional prefix,
embedded urls live beneath another resource. Setting type to 'embedded will allow you
to have links like:
All versions of hateoas-bundle with dependencies
jms/serializer-bundle Version dev-master
doctrine/common Version >2.4.0