From 918b4c7db839a64a9e812b2041ff1c092dd522cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20D=C9=AA=E1=B4=87=E1=B4=84=E1=B4=8B=E1=B4=8F?= =?UTF-8?q?=E1=B4=A1=20=E8=BF=AA=E6=8B=89=E6=96=AF?= Date: Sun, 13 Mar 2011 01:38:24 +0100 Subject: REST interfaces by definition cannot have out-of-band description documents --- spore_description.pod | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'spore_description.pod') 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 (Bpecifications to a Brtable BEST Bnvironment) 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 is a REST application that can exchange data with client +An I 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. -- cgit v1.2.3