The restful Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The restful Reference Manual

This is the restful Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:31:06 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

restful

JSON REST APIs made easy.

In other words, spin up a fully standards-compliant1 JSON API over HTTP in Common Lisp by providing a simple class.

Not yet available on quicklisp.

Documentation available here.

An example of an implementation is available here.

1 Closely follows RFC 7230, RFC 7231 and RFC 5789.

Dependencies

This library uses (and exposes its usage) the following dependencies:

The following dependencies are used internally:

Roadmap


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 restful

Author

Florian Margaine <florian@margaine.com>

License

MIT License

Description

Spin up new REST entities like madman

Dependencies
Source

restful.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 restful/src

Parent

restful (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 restful.asd

Location

restful.asd

Systems

restful (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 restful/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

restful


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 restful/src/condition.lisp

Parent

src (module)

Location

src/condition.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 restful/src/storage.lisp

Parent

src (module)

Location

src/storage.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 restful/src/storages/memory.lisp

Parent

src (module)

Location

src/storages/memory.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.6 restful/src/resource-metaclass.lisp

Parent

src (module)

Location

src/resource-metaclass.lisp

Exported Definitions

resource-metaclass (class)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.7 restful/src/slot.lisp

Parent

src (module)

Location

src/slot.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.8 restful/src/resource.lisp

Parent

src (module)

Location

src/resource.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.9 restful/src/collection.lisp

Parent

src (module)

Location

src/collection.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.10 restful/src/http.lisp

Parent

src (module)

Location

src/http.lisp

Internal Definitions

http-error (function)


Previous: , Up: Lisp files   [Contents][Index]

4.1.11 restful/src/acceptor.lisp

Parent

src (module)

Location

src/acceptor.lisp

Exported Definitions

acceptor (class)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 restful

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Generic functions

Generic Function: create-resource RESOURCE REQUEST-DATA

Creates a new resource based on the request data.

Package

restful

Source

resource.lisp (file)

Methods
Method: create-resource (RESOURCE resource) REQUEST-DATA

Creates a new resource in the storage based on the request data.

Generic Function: delete-item STORAGE IDENTIFIER

Deletes a single item in the storage.

Package

restful

Source

storage.lisp (file)

Methods
Method: delete-item (STORAGE memory-storage) IDENTIFIER

Deletes the item from the hash table. The identifier is the key of the hash table.

Source

storages/memory.lisp (file)

Generic Function: delete-resource RESOURCE

Deletes an existing resource.

Package

restful

Source

resource.lisp (file)

Methods
Method: delete-resource (RESOURCE resource)

Deletes an existing resource. If the resource doesn’t exist, an error was already thrown earlier thanks to load-resource.

Generic Function: get-item STORAGE IDENTIFIER

Gets a single item in the storage. Returns a plist.

Package

restful

Source

storage.lisp (file)

Methods
Method: get-item (STORAGE memory-storage) IDENTIFIER

Gets a single item according to its identifier. Returns a plist. The identifier is the key of the hash table.

Source

storages/memory.lisp (file)

Generic Function: get-items STORAGE

Gets all the items available in the storage.

This should be overridden for a specific storage if sorting/filtering options want to be added.

Returns a list of plists.

Package

restful

Source

storage.lisp (file)

Methods
Method: get-items (STORAGE memory-storage)

Gets all the items stored in the current instance.

Source

storages/memory.lisp (file)

Generic Function: has-permission RESOURCE METHOD

Determines if the request has permission to hit the resource. If it doesn’t, returns NIL.

Package

restful

Source

resource.lisp (file)

Methods
Method: has-permission (RESOURCE resource) METHOD

Returns T. Override this method to change the behavior.

Generic Function: load-resource RESOURCE

Loads a resource based on its identifier.

Package

restful

Source

resource.lisp (file)

Methods
Method: load-resource (RESOURCE resource)

Loads the resource using its storage. A resource-not-found-error error is raised if the resource was not found.

Generic Function: parent OBJECT
Package

restful

Methods
Method: parent (COLLECTION collection)

The parent resource, if any. If there’s no parent, its value is NIL.

Source

collection.lisp (file)

Method: parent (RESOURCE resource)

Stores the parent of the resource in case of
hierarchy. For example, if hitting foo/bar/baz/qux, the resource with identifier ’qux’ will have ’bar’ as parent. If there’s no parent, its value is NIL.

Source

resource.lisp (file)

Generic Function: patch-resource RESOURCE REQUEST-DATA

Patches an existing resource based on the request data.

Package

restful

Source

resource.lisp (file)

Methods
Method: patch-resource (RESOURCE resource) REQUEST-DATA

Patches an existing resource based on the request data.

Generic Function: replace-resource RESOURCE REQUEST-DATA

Replaces a resource based on the request data.

Package

restful

Source

resource.lisp (file)

Methods
Method: replace-resource (RESOURCE resource) REQUEST-DATA

Replaces the resources based on the request data.

Generic Function: resource-action RESOURCE

Lets you handle actions on the resource.
The :identifier slot lets you know which action is called. This method is called for the POST requests, and routing should be handled by yourself. Here is a typical example of what it can look like:

(defmethod restful:resource-action ((res custom-resource)) (cond ((string= (identifier res) "login") #’handle-login) (t (http-page-not-found))))

Package

restful

Source

resource.lisp (file)

Methods
Method: resource-action (RESOURCE resource)

Returns a 404 Page Not Found. Raising a resource-not-found error doesn’t make sense.

Generic Function: save-item STORAGE RESOURCE

Saves an item in the storage, creating it if needed.

Since resources are created or updated with PUT requests, as long as you have an ID, a resource exists. Except if the user doesn’t have permission to PUT non-existing resources, but that’s handled at the application level, not at the storage level, which only cares that a resource has an identifier.

Package

restful

Source

storage.lisp (file)

Methods
Method: save-item (STORAGE memory-storage) RESOURCE

Saves or updates an item in the hash table. Since ‘(setf (gethash [...]))‘ is used, the ’save or update’ feature is very simply done.

Source

storages/memory.lisp (file)

Generic Function: storage OBJECT
Package

restful

Methods
Method: storage (COLLECTION collection)

The storage object that satisfies the interface of the ‘restful:storage‘ class.

Source

collection.lisp (file)

Method: storage (RESOURCE resource)

The storage object that satisfies the interface of the ‘restful:storage‘ class.

Source

resource.lisp (file)

Method: storage (MEMORY-STORAGE memory-storage)

The hash table used to store the items in memory.

Source

storages/memory.lisp (file)

Generic Function: view-collection COLLECTION

Returns an object that will be
serialized to json using the jonathan library.

Package

restful

Source

collection.lisp (file)

Methods
Method: view-collection (COLLECTION collection)

Returns an object populated by the collection’s storage.

Generic Function: view-resource RESOURCE

Returns an object that will be serialized to json using the jonathan library.

Package

restful

Source

resource.lisp (file)

Methods
Method: view-resource (RESOURCE resource)

Returns a plist representing the resource.


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Conditions

Condition: permission-rejected ()

Raised when a request doesn’t have access to the
requested resource.

This error is raised when the has-permission method of a resource returns NIL.

When this error is handled, the response will have the 403 status code.

This error can be raised with every method.

Package

restful

Source

condition.lisp (file)

Direct superclasses

error (condition)

Condition: request-data-missing ()

Raised when a request body doesn’t fulfill the
resource’s schema.

For example, if a resource is the following:

(defclass foo (restful:resource)
((id :is-identifier t)
(name :required t))
(:metaclass restful:resource-metaclass))

And the request body is the following:

{"id":"bar"}

This error will be raised.

When this error is handled, the response will have a 400 status code.

This error can be raised in the following requests: PUT, POST.

Package

restful

Source

condition.lisp (file)

Direct superclasses

error (condition)

Condition: resource-not-found-error ()

Raised when a request resource is not found.

When this error is handled, the response will have the 404 status code.

This error can be raised in the following requests: GET, PATCH, DELETE, POST.

Package

restful

Source

condition.lisp (file)

Direct superclasses

error (condition)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Classes

Class: acceptor ()

Base class for the acceptor, subclassing
a hunchentoot acceptor to be able to handle incoming requests.

This class defines the following slot:

- ‘resource-definition‘: defines the list of resources and
how to handle them. This is a hash table that must:
- define a string key being the prefix for the resources
- for each key, define a value being a hash table. This
hash table must:
- define a keyword key named ‘:class‘ being the resource class.
- define a keyword named ‘:collection‘ being the collection class.
- define a keyword named ‘:storage‘ being the storage instance. - define a keyword named ‘:children‘ being a new resource definition, if necessary.

This is an example of a resource definition (assuming the readers macros to define hash tables using brackets):

{
"article" {
:class ’article
:collection ’restful:collection
:storage (make-instance ’restful:memory-storage) :children {
"comment" {
:class ’comment
:collection ’restful:collection
:storage (make-instance ’restful:memory-storage) }
}
}
}

The API will be available through the following endpoints:

- ‘/article‘: collection endpoint.
- ‘/article/foo‘: resource ’foo’ of instance ‘article‘ endpoint.
- ‘/article/foo/comment/bar‘: resource ’bar’ of instance ‘comment‘, having for parent ’foo’ of instance ‘article‘ endpoint.

This class should be used to instantiate objects to be used
with hunchentoot.

Here is an example of such usage:

(hunchentoot:start
(make-instance ’restful:acceptor
:port 4242
:resource-definition *resource-definition*))

Package

restful

Source

acceptor.lisp (file)

Direct superclasses

acceptor (class)

Direct methods

acceptor-dispatch-request (method)

Direct slots
Slot: resource-definition

The resource definition, documented in the class documentation.

Type

hash-table

Initargs

:resource-definition

Class: collection ()

Base class for restful collections. There’s
not much reason to extend it with the current features.

Package

restful

Source

collection.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: parent

The parent resource, if any. If there’s no parent, its value is NIL.

Initargs

:parent

Readers

parent (generic function)

Slot: storage

The storage object that satisfies the interface of the ‘restful:storage‘ class.

Initargs

:storage

Readers

storage (generic function)

Slot: class-of-resource

The resource’s class of this collection.

Initargs

:class-of-resource

Readers

class-of-resource (generic function)

Class: memory-storage ()

Restful’s storage by storing the data in memory.

This is of course not very good for persistence matters (duh), but is perfect for development, and simply to show how a storage class can be built.

This storage just uses a hash table stored in a slot.

Package

restful

Source

storages/memory.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: storage

The hash table used to store the items in memory.

Initform

(make-hash-table :test (quote equal))

Readers

storage (generic function)

Class: resource ()

Base class for resources. All the resources
should extend this class to have the default (required) slots.

Package

restful

Source

resource.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: parent

Stores the parent of the resource in case of
hierarchy. For example, if hitting foo/bar/baz/qux, the resource with identifier ’qux’ will have ’bar’ as parent. If there’s no parent, its value is NIL.

Type

restful:resource

Initargs

:parent

Readers

parent (generic function)

Slot: storage

The storage object that satisfies the interface of the ‘restful:storage‘ class.

Type

restful:storage

Initargs

:storage

Readers

storage (generic function)

Class: resource-metaclass ()

The metaclass for resources, required to be
used by all the resources.

This metaclass allows resources to use new slot options:

- ‘is-identifier‘: defaults to NIL. Only one slot per resource should set this option to T. It will make the slot the identifier of the resource. The identifier is used to find the resource in the API. When set to T, the slot option ‘required‘ is implicitly set to T too.
- ‘required‘: defaults to NIL. When set to T, this slot will be required in the API requests.
- ‘default‘: defaults to ‘""‘. If the slot is not required, this value will be used to fill in the slot value if no value is provided.
- ‘excluded‘: defaults to NIL. When to set T, this slot will be ignored for the resource’s CRUD actions. For example, the ‘restful:resource‘ class uses it for its ‘parent‘ and ‘storage‘ slots.

Package

restful

Source

resource-metaclass.lisp (file)

Direct superclasses

standard-class (class)

Direct methods
  • compute-effective-slot-definition (method)
  • validate-superclass (method)
  • effective-slot-definition-class (method)
  • direct-slot-definition-class (method)

Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Functions

Function: equal-resource RESOURCE1 RESOURCE2
Package

restful

Source

resource.lisp (file)

Function: find-identifier-slot CLASS
Package

restful

Source

slot.lisp (file)

Function: get-resource-slots RESOURCE
Package

restful

Source

slot.lisp (file)

Function: handle-collection RESOURCE-HASH-VALUE PARENT
Package

restful

Source

acceptor.lisp (file)

Function: handle-delete-resource RESOURCE
Package

restful

Source

acceptor.lisp (file)

Function: handle-get-resource RESOURCE
Package

restful

Source

acceptor.lisp (file)

Function: handle-patch-resource RESOURCE
Package

restful

Source

acceptor.lisp (file)

Function: handle-post-resource RESOURCE
Package

restful

Source

acceptor.lisp (file)

Function: handle-put-resource RESOURCE
Package

restful

Source

acceptor.lisp (file)

Function: handle-resource PARTS RESOURCE-HASH-VALUE PARENT
Package

restful

Source

acceptor.lisp (file)

Function: handle-resource-method METHOD RESOURCE
Package

restful

Source

acceptor.lisp (file)

Function: handle-uri PARTS RESOURCES &optional PARENT
Package

restful

Source

acceptor.lisp (file)

Function: http-error CODE
Package

restful

Source

http.lisp (file)

Function: is-slot-excluded SLOT
Package

restful

Source

slot.lisp (file)

Function: normalize-keyword SYMBOL
Package

restful

Source

slot.lisp (file)

Function: normalize-keywords SYMBOLS
Package

restful

Source

slot.lisp (file)

Function: normalize-resource RESOURCE
Package

restful

Source

slot.lisp (file)

Function: populate-resource RESOURCE FILLER
Package

restful

Source

resource.lisp (file)

Function: populate-resources COLLECTION ITEMS
Package

restful

Source

collection.lisp (file)

Function: populate-slot RESOURCE FILLER
Package

restful

Source

slot.lisp (file)

Function: slot-default-value RESOURCE SLOT
Package

restful

Source

slot.lisp (file)

Function: slot-is-required RESOURCE SLOT
Package

restful

Source

slot.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Generic functions

Generic Function: class-of-resource OBJECT
Package

restful

Methods
Method: class-of-resource (COLLECTION collection)

The resource’s class of this collection.

Source

collection.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Classes

Class: resource-standard-direct-slot-definition ()
Package

restful

Source

resource-metaclass.lisp (file)

Direct superclasses

standard-direct-slot-definition (class)

Direct slots
Slot: is-identifier
Initargs

:is-identifier

Slot: required
Initargs

:required

Slot: default
Initargs

:default

Slot: excluded
Initargs

:excluded

Class: resource-standard-effective-slot-definition ()
Package

restful

Source

resource-metaclass.lisp (file)

Direct superclasses

standard-effective-slot-definition (class)

Direct slots
Slot: is-identifier
Initargs

:is-identifier

Slot: required
Initargs

:required

Slot: default
Initargs

:default

Slot: excluded
Initargs

:excluded


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   R  
Index Entry  Section

F
File, Lisp, restful.asd: The restful<dot>asd file
File, Lisp, restful/src/acceptor.lisp: The restful/src/acceptor<dot>lisp file
File, Lisp, restful/src/collection.lisp: The restful/src/collection<dot>lisp file
File, Lisp, restful/src/condition.lisp: The restful/src/condition<dot>lisp file
File, Lisp, restful/src/http.lisp: The restful/src/http<dot>lisp file
File, Lisp, restful/src/package.lisp: The restful/src/package<dot>lisp file
File, Lisp, restful/src/resource-metaclass.lisp: The restful/src/resource-metaclass<dot>lisp file
File, Lisp, restful/src/resource.lisp: The restful/src/resource<dot>lisp file
File, Lisp, restful/src/slot.lisp: The restful/src/slot<dot>lisp file
File, Lisp, restful/src/storage.lisp: The restful/src/storage<dot>lisp file
File, Lisp, restful/src/storages/memory.lisp: The restful/src/storages/memory<dot>lisp file

L
Lisp File, restful.asd: The restful<dot>asd file
Lisp File, restful/src/acceptor.lisp: The restful/src/acceptor<dot>lisp file
Lisp File, restful/src/collection.lisp: The restful/src/collection<dot>lisp file
Lisp File, restful/src/condition.lisp: The restful/src/condition<dot>lisp file
Lisp File, restful/src/http.lisp: The restful/src/http<dot>lisp file
Lisp File, restful/src/package.lisp: The restful/src/package<dot>lisp file
Lisp File, restful/src/resource-metaclass.lisp: The restful/src/resource-metaclass<dot>lisp file
Lisp File, restful/src/resource.lisp: The restful/src/resource<dot>lisp file
Lisp File, restful/src/slot.lisp: The restful/src/slot<dot>lisp file
Lisp File, restful/src/storage.lisp: The restful/src/storage<dot>lisp file
Lisp File, restful/src/storages/memory.lisp: The restful/src/storages/memory<dot>lisp file

M
Module, restful/src: The restful/src module

R
restful.asd: The restful<dot>asd file
restful/src: The restful/src module
restful/src/acceptor.lisp: The restful/src/acceptor<dot>lisp file
restful/src/collection.lisp: The restful/src/collection<dot>lisp file
restful/src/condition.lisp: The restful/src/condition<dot>lisp file
restful/src/http.lisp: The restful/src/http<dot>lisp file
restful/src/package.lisp: The restful/src/package<dot>lisp file
restful/src/resource-metaclass.lisp: The restful/src/resource-metaclass<dot>lisp file
restful/src/resource.lisp: The restful/src/resource<dot>lisp file
restful/src/slot.lisp: The restful/src/slot<dot>lisp file
restful/src/storage.lisp: The restful/src/storage<dot>lisp file
restful/src/storages/memory.lisp: The restful/src/storages/memory<dot>lisp file

Jump to:   F   L   M   R  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   C   D   E   F   G   H   I   L   M   N   P   R   S   V  
Index Entry  Section

C
class-of-resource: Internal generic functions
class-of-resource: Internal generic functions
create-resource: Exported generic functions
create-resource: Exported generic functions

D
delete-item: Exported generic functions
delete-item: Exported generic functions
delete-resource: Exported generic functions
delete-resource: Exported generic functions

E
equal-resource: Internal functions

F
find-identifier-slot: Internal functions
Function, equal-resource: Internal functions
Function, find-identifier-slot: Internal functions
Function, get-resource-slots: Internal functions
Function, handle-collection: Internal functions
Function, handle-delete-resource: Internal functions
Function, handle-get-resource: Internal functions
Function, handle-patch-resource: Internal functions
Function, handle-post-resource: Internal functions
Function, handle-put-resource: Internal functions
Function, handle-resource: Internal functions
Function, handle-resource-method: Internal functions
Function, handle-uri: Internal functions
Function, http-error: Internal functions
Function, is-slot-excluded: Internal functions
Function, normalize-keyword: Internal functions
Function, normalize-keywords: Internal functions
Function, normalize-resource: Internal functions
Function, populate-resource: Internal functions
Function, populate-resources: Internal functions
Function, populate-slot: Internal functions
Function, slot-default-value: Internal functions
Function, slot-is-required: Internal functions

G
Generic Function, class-of-resource: Internal generic functions
Generic Function, create-resource: Exported generic functions
Generic Function, delete-item: Exported generic functions
Generic Function, delete-resource: Exported generic functions
Generic Function, get-item: Exported generic functions
Generic Function, get-items: Exported generic functions
Generic Function, has-permission: Exported generic functions
Generic Function, load-resource: Exported generic functions
Generic Function, parent: Exported generic functions
Generic Function, patch-resource: Exported generic functions
Generic Function, replace-resource: Exported generic functions
Generic Function, resource-action: Exported generic functions
Generic Function, save-item: Exported generic functions
Generic Function, storage: Exported generic functions
Generic Function, view-collection: Exported generic functions
Generic Function, view-resource: Exported generic functions
get-item: Exported generic functions
get-item: Exported generic functions
get-items: Exported generic functions
get-items: Exported generic functions
get-resource-slots: Internal functions

H
handle-collection: Internal functions
handle-delete-resource: Internal functions
handle-get-resource: Internal functions
handle-patch-resource: Internal functions
handle-post-resource: Internal functions
handle-put-resource: Internal functions
handle-resource: Internal functions
handle-resource-method: Internal functions
handle-uri: Internal functions
has-permission: Exported generic functions
has-permission: Exported generic functions
http-error: Internal functions

I
is-slot-excluded: Internal functions

L
load-resource: Exported generic functions
load-resource: Exported generic functions

M
Method, class-of-resource: Internal generic functions
Method, create-resource: Exported generic functions
Method, delete-item: Exported generic functions
Method, delete-resource: Exported generic functions
Method, get-item: Exported generic functions
Method, get-items: Exported generic functions
Method, has-permission: Exported generic functions
Method, load-resource: Exported generic functions
Method, parent: Exported generic functions
Method, parent: Exported generic functions
Method, patch-resource: Exported generic functions
Method, replace-resource: Exported generic functions
Method, resource-action: Exported generic functions
Method, save-item: Exported generic functions
Method, storage: Exported generic functions
Method, storage: Exported generic functions
Method, storage: Exported generic functions
Method, view-collection: Exported generic functions
Method, view-resource: Exported generic functions

N
normalize-keyword: Internal functions
normalize-keywords: Internal functions
normalize-resource: Internal functions

P
parent: Exported generic functions
parent: Exported generic functions
parent: Exported generic functions
patch-resource: Exported generic functions
patch-resource: Exported generic functions
populate-resource: Internal functions
populate-resources: Internal functions
populate-slot: Internal functions

R
replace-resource: Exported generic functions
replace-resource: Exported generic functions
resource-action: Exported generic functions
resource-action: Exported generic functions

S
save-item: Exported generic functions
save-item: Exported generic functions
slot-default-value: Internal functions
slot-is-required: Internal functions
storage: Exported generic functions
storage: Exported generic functions
storage: Exported generic functions
storage: Exported generic functions

V
view-collection: Exported generic functions
view-collection: Exported generic functions
view-resource: Exported generic functions
view-resource: Exported generic functions

Jump to:   C   D   E   F   G   H   I   L   M   N   P   R   S   V  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   C   D   E   I   P   R   S  
Index Entry  Section

C
class-of-resource: Exported classes

D
default: Internal classes
default: Internal classes

E
excluded: Internal classes
excluded: Internal classes

I
is-identifier: Internal classes
is-identifier: Internal classes

P
parent: Exported classes
parent: Exported classes

R
required: Internal classes
required: Internal classes
resource-definition: Exported classes

S
Slot, class-of-resource: Exported classes
Slot, default: Internal classes
Slot, default: Internal classes
Slot, excluded: Internal classes
Slot, excluded: Internal classes
Slot, is-identifier: Internal classes
Slot, is-identifier: Internal classes
Slot, parent: Exported classes
Slot, parent: Exported classes
Slot, required: Internal classes
Slot, required: Internal classes
Slot, resource-definition: Exported classes
Slot, storage: Exported classes
Slot, storage: Exported classes
Slot, storage: Exported classes
storage: Exported classes
storage: Exported classes
storage: Exported classes

Jump to:   C   D   E   I   P   R   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   A   C   M   P   R   S  
Index Entry  Section

A
acceptor: Exported classes

C
Class, acceptor: Exported classes
Class, collection: Exported classes
Class, memory-storage: Exported classes
Class, resource: Exported classes
Class, resource-metaclass: Exported classes
Class, resource-standard-direct-slot-definition: Internal classes
Class, resource-standard-effective-slot-definition: Internal classes
collection: Exported classes
Condition, permission-rejected: Exported conditions
Condition, request-data-missing: Exported conditions
Condition, resource-not-found-error: Exported conditions

M
memory-storage: Exported classes

P
Package, restful: The restful package
permission-rejected: Exported conditions

R
request-data-missing: Exported conditions
resource: Exported classes
resource-metaclass: Exported classes
resource-not-found-error: Exported conditions
resource-standard-direct-slot-definition: Internal classes
resource-standard-effective-slot-definition: Internal classes
restful: The restful system
restful: The restful package

S
System, restful: The restful system

Jump to:   A   C   M   P   R   S