diff options
| author | Lars Dɪᴇᴄᴋᴏᴡ 迪拉斯 <daxim@cpan.org> | 2011-03-13 01:38:24 +0100 |
|---|---|---|
| committer | franck cuny <franck@lumberjaph.net> | 2011-03-17 08:57:57 +0100 |
| commit | 918b4c7db839a64a9e812b2041ff1c092dd522cc (patch) | |
| tree | 02098f8adc3321567403b4f9369b06d7ada17404 /spore_description.pod | |
| parent | spelling (diff) | |
| download | spore-specifications-918b4c7db839a64a9e812b2041ff1c092dd522cc.tar.gz | |
REST interfaces by definition cannot have out-of-band description documents
Diffstat (limited to 'spore_description.pod')
| -rw-r--r-- | spore_description.pod | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/spore_description.pod b/spore_description.pod index 4e258db..5cf5e9b 100644 --- a/spore_description.pod +++ b/spore_description.pod @@ -6,17 +6,18 @@ Spore (B<S>pecifications to a B<Po>rtable B<R>EST B<E>nvironment) Description Im =head1 ABSTRACT -Spore is a specification for describing REST API that can be parsed and used +Spore is a specification for describing HTTP APIs which happen to suffice some +constraints laid out by the REST architectural style. It can be parsed and used automatically by client implementations to communicate with the described API. -This document describes how to write the description for a REST API in +This document describes how to write the description for such an API in order to be used with a SPORE Client Implementation. =head1 TERMINOLOGY =head2 API -An I<API> is a REST application that can exchange data with client +An I<API> is the interface to an application that can exchange data with client applications over HTTP/HTTPS. It presents one or more method endpoints which accept HTTP requests with varying headers, parameters and body content to perform specific operations. |