#Swagger Maven Plugin Sample ## HTTP | HTTPS://petstore.swagger.wordnik.com/api This is a sample for swagger-maven-plugin [**Contact the developer**](mailto:kongchen@gmail.com) **Version** v1 [**Terms of Service**](http://www.github.com/kongchen/swagger-maven-plugin) [**Apache 2.0**](http://www.apache.org/licenses/LICENSE-2.0.html) # APIs ## /api/v1/products ### GET <a id="getProductList"></a> #### Request **Content-Type: ** application/json; charset=UTF-8, text/xml; charset=UTF-8 ##### Parameters #### Response **Content-Type: ** application/json; charset=UTF-8, text/xml; charset=UTF-8 | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Payload">Payload</a>| ### POST <a id="createProduct"></a> #### Request **Content-Type: ** application/json; charset=UTF-8, text/xml; charset=UTF-8 ##### Parameters #### Response **Content-Type: ** application/json; charset=UTF-8, text/xml; charset=UTF-8 | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Payload">Payload</a>| ## /api/v1/products/{id} ### GET <a id="getProductById"></a> #### Request **Content-Type: ** application/json; charset=UTF-8, text/xml; charset=UTF-8 ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td> (**Pattern**: `\d+`)</td> <td> - </td> <td>integer (int32)</td> </tr> </table> #### Response **Content-Type: ** application/json; charset=UTF-8, text/xml; charset=UTF-8 | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Payload">Payload</a>| ### PUT <a id="updateProductById"></a> #### Request **Content-Type: ** application/json; charset=UTF-8, text/xml; charset=UTF-8 ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td> (**Pattern**: `\d+`)</td> <td> - </td> <td>integer (int32)</td> </tr> </table> #### Response **Content-Type: ** application/json; charset=UTF-8, text/xml; charset=UTF-8 | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Payload">Payload</a>| ### DELETE <a id="deleteProductById"></a> #### Request **Content-Type: ** application/json; charset=UTF-8, text/xml; charset=UTF-8 ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td> (**Pattern**: `\d+`)</td> <td> - </td> <td>integer (int32)</td> </tr> </table> #### Response **Content-Type: ** application/json; charset=UTF-8, text/xml; charset=UTF-8 | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Payload">Payload</a>| ## /api/v1/resources ### GET <a id="getAvailableEndpointsHtml"></a> #### Request **Content-Type: ** application/json; charset=UTF-8, text/xml; charset=UTF-8 ##### Parameters #### Response **Content-Type: ** text/html | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | # Definitions ## <a name="/definitions/MethodDescription">MethodDescription</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>method</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>fullPath</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>produces</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>consumes</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pathParams</td> <td> array[object] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>queryParams</td> <td> array[object] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>requestBody</td> <td> array[object] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>returnType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Payload">Payload</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>payload</td> <td> object </td> <td>optional</td> <td>-</td> <td></td> </tr> </table>