Created
October 20, 2011 01:29
-
-
Save subnetmarco/1300184 to your computer and use it in GitHub Desktop.
XML v4
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<api format="JSON"> | |
<authentication type="header"> | |
<description><![CDATA[This is a simple header authentication]]><description> | |
<parameters> | |
<parameter name="X-Pippo-Username" optional="false"> | |
<description><![CDATA[Please enter here your username]]></description> | |
</parameter> | |
<parameter name="X-Pippo-Password" optional="false"> | |
<description><![CDATA[Please enter here your password]]></description> | |
</parameter> | |
</parameters> | |
</authentication> | |
<endpoint http="POST" name="Get User" group="Users" authentication="true"> | |
<description><![CDATA[This is a sample description for the method]]><description> | |
<route><![CDATA[/url/{id}]]></route> | |
<parameters> | |
<parameter name="id" optional="false" type="String" default="12"> | |
<!-- Parameter Documentation --> | |
<description><![CDATA[This is a sample description for the parameter]]></description> | |
<values> | |
<value>1</value> | |
<value>2</value> | |
<value>3</value> | |
</values> | |
<parameter> | |
</parameters> | |
<!-- The type can be a primitive type (String, Number, Boolean) or a custom Model. --> | |
<response type="List[User]" optional="false" /> | |
<!-- Errors --> | |
<errors> | |
<error code="404"> | |
<description><![CDATA[The user was not found]]></description> | |
</error> | |
<error code="500" type="FatalError"> | |
<description><![CDATA[The user was not found]]></description> | |
</error> | |
</errors> | |
</endpoint> | |
<model name="User"> | |
<description>This is a User model<description> | |
<example> | |
<![CDATA[ | |
{ | |
“username” : “Marco” | |
} | |
]]> | |
</example> | |
<fields> | |
<field name="username" optional="false" type="String" default="pippo"> | |
<description>This is a sample result field</description> | |
<example>3</example> | |
<values> | |
<value>1</value> | |
<value>2</value> | |
<value>3</value> | |
</values> | |
</field> | |
<field name="status" optional="false" type="String" > | |
<description>This is a sample result field</description> | |
<example>active</example> | |
<values> | |
<value>active</value> | |
<value>disabled</value> | |
<value>deleted</value> | |
</values> | |
</field> | |
</fields> | |
</model> | |
</api> |
L'error molte volte ha una risposta (quasi sempre). Per noi la gestione del Model nell'error e' indifferente, e' come se fosse il model di un field qualsiasi. Io direi di aggiungerlo, ad esempio oggi i developer di Marco Trombetti mi avevano chiesto se potevano farlo e gli ho detto di si.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Il type nell'error è necessario?
Potremmo aggiungerlo dopo come una enumeration per indicare la gravità dell'errore, sulla quale fare delle statistiche/report, però al momento mi sembra solo un'appesantimento (c'è già la description)