Jackalope

KO | EN

gitlite — search

#javascript #python #typescript #golang #rust #linux #nodejs #java #windows #awesome #cli #kubernetes #awesome-list #ios

(★ 24)

A rabbit with horns

Jackalope Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Jackalope

Jackalope is a framework for building REST style web services with embedded
hypermedia controls. It was heavily inspired by the description of "Level 3"
web services as described in [this article](http://martinfowler.com/articles/richardsonMaturityModel.html#level3)
by Martin Fowler and the book [REST in Practice](http://restinpractice.com/default.aspx).

## Core Concepts

Jackalope is built of a couple of different parts. The first part is the
schema language, which describes the messages to be sent and received. The
second part is the hypermedia controls, which are themselves described
in the schema language. And the last part is the REST style web services which
is found in Jackalope::REST.

### Schema Language

The schema language is actually just Perl data structures, but it is simple enough
that it could be written in most any simple data serialization language, like JSON,
YAML or a dialect of XML. The schema language is also self-describing, meaning that
each core element of the language is described with the language itself. There is
support for a set of core types which are shown below in the type hierarchy.

Any
        Null
        Boolean
        Number
            Integer
        String
        Array[ T ]
        Object[ String, T ]
          Schema

Additionally the core schema language also supports references (using the JSON
__ref__ syntax) and through the use of references it is also possible to 'extend'
a schema, which is similar to object oriented inheritance, but different.

It should be noted that the schema language draws much of its syntactic inspiration
from [JSON-Schema](http://www.json-schema.org) however the underlying implementation
and core philosophy differ greatly.

The documentation for the schema types themselves is contained within the
schema (see, like really self-describing), take a look at Jackalope::Schema::Spec
to see this documentation. I recommend reading that document from top to bottom,
after which you should have all the information to understand what you just read,
so I recommend re-reading it then. Hopefully at that point, it will all make sense.

### Hypermedia controls

In the core set of schemas we also provide a basic 'linkrel' schema and an 'hyperlink'
schema. The 'linkrel' schema is for describing the concept of a link enough so that
a link could easily be created from the available metadata. The 'hyperlink' schema is
for describing the concrete implementation of a 'linkrel'. It is perhaps useful to
think of a 'linkrel' like a class and 'hyperlink' like an object instance, they have
a similar relationship to one another.

The base 'any' schema type provides an optional 'links' property, which is a key-value
mapping of 'linkrels' where the 'rel' name is the key. These are meant to describe the
possible actions that can be taken against a given schema. Think of them as methods,
where the schema is the class. These are also used by the REST style web services to
generate the routes that can be called on the service, and used to generate a set of
hypermedia controls for an instance of the schema.

### REST style web services

See Jackalope::REST

## Installation

To install this module type the following:

perl Makefile.PL
    make
    make test
    make install

## Dependencies

This module requires these other modules and libraries:

Moose
    MooseX::Getopt
    MooseX::Types::Path::Class
    MooseX::Params::Validate
    Bread::Board
    JSON::XS
    Try::Tiny
    Class::Load
    Clone
    Digest
    File::Spec::Unix
    List::AllUtils
    Data::Visitor::Callback
    Scalar::Util
    Data::Peek
    Data::Dumper
    Devel::PartialDump
    Template
    FindBin

Test::More
    Test::Moose
    Test::Fatal
    Test::Builder

## Copyright and License

(http://www.iinteractive.com)

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

Jackalope

Jackalope Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Jackalope

Jackalope Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README