Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Template:Orion/ServerAPI
Revision as of 16:25, 10 January 2011 by John arthorne.ca.ibm.com (Talk | contribs) (New page: <noinclude> This is a template for documenting REST-oriented Web APIs. {{Usage|<pre>{{WebAPI | overview = Obtain file contents | method = GET | reqhead = /file/myfile.txt HTTP/1.1 | resph...)
This is a template for documenting REST-oriented Web APIs.
Markup | Rendering | |
---|---|---|
|
Method
- The HTTP Method
Overview
- A textual overview of the purpose of the method
reqhead
- The HTTP headers of the request
reqbody
- The body of the HTTP request
resphead
- The HTTP headers of the response
respbody
- The body of the HTTP response
Explain
- Detailed explanation of this method.