Difference between revisions of "Template:Orion/ServerAPI"

Revision as of 15:09, 28 February 2011

This is a template for documenting REST-oriented Web APIs.

Markup

Rendering

{{Orion/ServerAPI
| overview = Obtain file contents
| method = GET
| reqhead = /file/myfile.txt HTTP/1.1
| resphead = 201 OK
| explain = Detailed explanation
}}

Overview: Obtain file contents
HTTP Method: GET
Example Request

GET /file/myfile.txt HTTP/1.1

Example Response

HTTP/1.1 201 OK

Detailed Explanation: Detailed explanation

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.

@@ Line 44: / Line 44: @@
 :{{{method}}}
 ;Example Request
-  <span style="color:green">{{{method}}} {{{reqhead}}}</span>
+  <span style="color:green">{{{method}}} {{{reqhead}}}</span>{{{#if:{{{reqbody|}}}|<br>  {{{reqbody|}}}|}}}
- {{{#if:{{{reqbody|}}}|{{{reqbody|}}}<br>|}}}
 ;Example Response
-  <span style="color:green">HTTP/1.1 {{{resphead}}}</span>
+  <span style="color:green">HTTP/1.1 {{{resphead}}}</span>{{{#if:{{{respbody|}}}|<br>  {{{respbody|}}}|}}}
- {{{#if:{{{respbody|}}}|{{{respbody|}}}<br>|}}}
 ;Detailed Explanation
 :{{{explain}}}
 </includeonly>

Breadcrumbs

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.

Difference between revisions of "Template:Orion/ServerAPI"

Revision as of 15:09, 28 February 2011