Difference between revisions of "Template: Web API"
(Created page with "<noinclude> == Usage == Use this template to build page content via Cargo queries for a specific Web API. {{Web_API |name= Name of API |category= (optional) category to sort...") |
|||
| Line 49: | Line 49: | ||
</noinclude> | </noinclude> | ||
| + | <includeonly> | ||
=={{#if: {{{category}}} | {{{category}}} | {{{name}}} }}== | =={{#if: {{{category}}} | {{{category}}} | {{{name}}} }}== | ||
===Base path: {{apibasepath}}=== | ===Base path: {{apibasepath}}=== | ||
| Line 85: | Line 86: | ||
</source> | </source> | ||
--> | --> | ||
| + | </includeonly> | ||
Revision as of 15:35, November 6, 2023
Usage[edit source]
Use this template to build page content via Cargo queries for a specific Web API.
(optional) category to sort API queries into[edit source]
Base path: base URL used for API requests[edit source]
Cargo queries will return all API requests and related info for the matching API name and category (if provided; otherwise category is ignored and all API requests are returned).
Swagger content API definition is broken into three parts for Cargo storage: API request details; API request parameters; API request responses.
{{Web_API_Request |apibasepath= base URL used for API requests |apipath= added to base path to create the full API request URL |apitype= DELETE, GET, POST, PUT |category= (optional) category to sort API queries into |summary= short description used in abbreviated form |description= long description |usage= }} {{Web_API_Parameter |apibasepath= base URL used for API requests |apipath= added to base path to create the full API request URL |apitype= DELETE, GET, POST, PUT |name= |default= |description= |parametertype= |datatype= |required= |example= }} {{Web_API_Response |apibasepath= base URL used for API requests |apipath= added to base path to create the full API request URL |apitype= DELETE, GET, POST, PUT |code= |reason= |example= }}