diff options
| -rw-r--r-- | spore_description.pod | 7 | ||||
| -rw-r--r-- | spore_implementation.pod | 5 | ||||
| -rw-r--r-- | t/spelling.t | 1 |
3 files changed, 8 insertions, 5 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. diff --git a/spore_implementation.pod b/spore_implementation.pod index 8218651..83f82e1 100644 --- a/spore_implementation.pod +++ b/spore_implementation.pod @@ -6,7 +6,8 @@ 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 what features are required in a Spore client @@ -18,7 +19,7 @@ implementation. =item 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. diff --git a/t/spelling.t b/t/spelling.t index 7947839..4237903 100644 --- a/t/spelling.t +++ b/t/spelling.t @@ -26,6 +26,7 @@ Perrad ## computerese API +APIs CGI JSGI JSON |