Difference between revisions of "Documentation/WADL conventions"
(→WADL markup conventions) |
(→What is WADL?) |
||
| Line 6: | Line 6: | ||
* An XML vocabulary that describes RESTful APIs. | * An XML vocabulary that describes RESTful APIs. | ||
* Machine- and human-readable. | * Machine- and human-readable. | ||
| − | * Can be referenced in Docbook files to generate API reference documentation. | + | * Can be referenced in Docbook files to generate API reference documentation.<br /> |
| + | |||
For complete information about the WADL language, see [http://www.w3.org/Submission/wadl/ Web Application Description Language] (http://www.w3.org/Submission/wadl/). | For complete information about the WADL language, see [http://www.w3.org/Submission/wadl/ Web Application Description Language] (http://www.w3.org/Submission/wadl/). | ||
Revision as of 21:09, 20 February 2014
WADL markup conventions
What is WADL?
- An acronym for Web Application Description Language.
- An XML vocabulary that describes RESTful APIs.
- Machine- and human-readable.
- Can be referenced in Docbook files to generate API reference documentation.
For complete information about the WADL language, see Web Application Description Language (http://www.w3.org/Submission/wadl/).
Markup
For list methods, use the text: "Lists available xxx." Do not use "Gets a listing," or "Prints a listing." For show (or get) methods, use the text: "Shows xxx details." Do not use, "Retrieves information about," or "Gets information for."
