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"
(revert) |
|||
(6 intermediate revisions by 2 users not shown) | |||
Line 36: | Line 36: | ||
'''Explain''' | '''Explain''' | ||
:Detailed explanation of this method. | :Detailed explanation of this method. | ||
− | |||
</noinclude> | </noinclude> | ||
<includeonly> | <includeonly> | ||
Line 44: | Line 43: | ||
:{{{method}}} | :{{{method}}} | ||
;Example Request | ;Example Request | ||
− | <span style="color:green">{{{method}}} {{{reqhead}}}</span> | + | <span style="color:green">{{{method}}} {{{reqhead}}}</span> |
+ | |||
+ | {{{reqbody|}}} | ||
;Example Response | ;Example Response | ||
− | <span style="color:green">HTTP/1.1 {{{resphead}}}</span> | + | <span style="color:green">HTTP/1.1 {{{resphead}}}</span> |
+ | |||
+ | {{{respbody|}}} | ||
;Detailed Explanation | ;Detailed Explanation | ||
:{{{explain}}} | :{{{explain}}} | ||
</includeonly> | </includeonly> |
Latest revision as of 14:35, 11 September 2017
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.