Logged in: Logged in as: Log in
Register
Locations of visitors to this page SourceForge.net
free download
install guides
free wiki hosting
enterprise support
.
support
partners
Search:
Page last modified 23:59, 1 Feb 2007 by SteveB
Permalink: http://tinyurl.com/6g2vbo
Template:Service Description >

Template:Service Description

Table of contents
  1. 1. Overview
  2. 2. Data Types
    1. 2.1. Config
    2. 2.2. Typename
  3. 3. Features
      1. 3.1.1. GET:path/
        1. 3.1.1.1. Query Parameters
        2. 3.1.1.2. Request Body
        3. 3.1.1.3. Response
        4. 3.1.1.4. Version History

Assembly: (assembly name)

Class: (class name)

Overview

(provide a short 2-3 sentence description of what the service does)



Verb:Suffix Description
GET:path1 (1 sentence description)
POST:path2/* (ditto)


Data Types

(Describe XML document types by example)

Config

(provide a sample configuration for service which use it)

<config>
	<!-- use xml comments to describe entries --!>
	...
</config>


Typename

<doc>
	<node>
		...
	</node>
</node>

Features

GET:path/

(Expanded description -or- copy-paste 1 sentence description again; use Feature template to insert more feature descriptions)

Query Parameters
Name Type Description
queryarg1 int (1 sentence description
queryarg2 text (1 sentence description
Request Body

(Description/example of the purpose of the request body)

Response
Status Description
200 (1-3 sentence description of response contents)
203 (1-3 setnence description of response contents)
Version History

(OPTIONAL: version history/change log of feature)


Tag page
What links here

Files 0

Attach file or image
 

Images 0

 
You must login to post a comment.
Powered by MindTouch Deki v.8.08