Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Template:Orion/ServerAPI"
(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...) |
|||
Line 2: | Line 2: | ||
This is a template for documenting REST-oriented Web APIs. | This is a template for documenting REST-oriented Web APIs. | ||
− | {{Usage|<pre>{{ | + | {{Usage|<pre>{{Orion/ServerAPI |
| overview = Obtain file contents | | overview = Obtain file contents | ||
| method = GET | | method = GET | ||
Line 8: | Line 8: | ||
| resphead = 201 OK | | resphead = 201 OK | ||
| explain = Detailed explanation | | explain = Detailed explanation | ||
− | }}</pre>|2={{ | + | }}</pre>|2={{Orion/ServerAPI |
| overview = Obtain file contents | | overview = Obtain file contents | ||
| method = GET | | method = GET |
Revision as of 16:26, 10 January 2011
This is a template for documenting REST-oriented Web APIs.
Markup | Rendering | |
---|---|---|
|
GET /file/myfile.txt HTTP/1.1
HTTP/1.1 201 OK
|
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.