Template:Orion/ServerAPI

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.