valitydev/openapi-generator
14
0
Fork 0
mirror of https://github.com/valitydev/openapi-generator.git synced 2024-11-07 10:58:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

updated sample

Browse Source
This commit is contained in:
Tony Tam 2014-09-28 00:52:32 -07:00
parent d714f097eb
commit c75a951668
12 changed files with 501 additions and 440 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
samples/swagger-static-docs/docs/assets/images/logo.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 25 KiB

99
samples/swagger-static-docs/docs/index.html
View File

@ -29,48 +29,77 @@
<li>Getting Started</li>
</ul>
</div>
<div class="section-box">
<div class="section-header">
<a href="#!/UserApi">UserApi</a>
</div>
<ul>
<li><a href="#!/UserApi#updateUser">updateUser</a></li>
<li><a href="#!/UserApi#deleteUser">deleteUser</a></li>
<li><a href="#!/UserApi#getUserByName">getUserByName</a></li>
<li><a href="#!/UserApi#loginUser">loginUser</a></li>
<li><a href="#!/UserApi#logoutUser">logoutUser</a></li>
<li><a href="#!/UserApi#createUser">createUser</a></li>
<li><a href="#!/UserApi#createUsersWithArrayInput">createUsersWithArrayInput</a></li>
<li><a href="#!/UserApi#createUsersWithListInput">createUsersWithListInput</a></li>
</ul>
</div>
<div class="section-box">
<div class="section-header">
<a href="#!/PetApi">PetApi</a>
</div>
<ul>
<li><a href="#!/PetApi#getPetById">getPetById</a></li>
<li><a href="#!/PetApi#deletePet">deletePet</a></li>
<li><a href="#!/PetApi#partialUpdate">partialUpdate</a></li>
<li><a href="#!/PetApi#updatePetWithForm">updatePetWithForm</a></li>
<li><a href="#!/PetApi#uploadFile">uploadFile</a></li>
<li><a href="#!/PetApi#addPet">addPet</a></li>
<li><a href="#!/PetApi#updatePet">updatePet</a></li>
<li><a href="#!/PetApi#findPetsByStatus">findPetsByStatus</a></li>
<li><a href="#!/PetApi#findPetsByTags">findPetsByTags</a></li>
</ul>
</div>
<div class="section-box">
<div class="section-header">
<a href="#!/StoreApi">StoreApi</a>
</div>
<ul>
<li><a href="#!/StoreApi#getOrderById">getOrderById</a></li>
<li><a href="#!/StoreApi#deleteOrder">deleteOrder</a></li>
<li><a href="#!/StoreApi#placeOrder">placeOrder</a></li>
</ul>
<li><a href="#!/StoreApi#getOrderById">getOrderById</a></li>
<li><a href="#!/StoreApi#deleteOrder">deleteOrder</a></li>
</ul>
</div>
<div class="section-box">
<div class="section-header">
<a href="#!/PetApi">PetApi</a>
</div>
<ul>
<li><a href="#!/PetApi#updatePet">updatePet</a></li>
<li><a href="#!/PetApi#addPet">addPet</a></li>
<li><a href="#!/PetApi#findPetsByStatus">findPetsByStatus</a></li>
<li><a href="#!/PetApi#findPetsByTags">findPetsByTags</a></li>
<li><a href="#!/PetApi#getPetById">getPetById</a></li>
<li><a href="#!/PetApi#deletePet">deletePet</a></li>
</ul>
</div>
<div class="section-box">
<div class="section-header">
<a href="#!/UserApi">UserApi</a>
</div>
<ul>
<li><a href="#!/UserApi#createUser">createUser</a></li>
<li><a href="#!/UserApi#createUsersWithArrayInput">createUsersWithArrayInput</a></li>
<li><a href="#!/UserApi#createUsersWithListInput">createUsersWithListInput</a></li>
<li><a href="#!/UserApi#loginUser">loginUser</a></li>
<li><a href="#!/UserApi#logoutUser">logoutUser</a></li>
<li><a href="#!/UserApi#getUserByName">getUserByName</a></li>
<li><a href="#!/UserApi#updateUser">updateUser</a></li>
<li><a href="#!/UserApi#deleteUser">deleteUser</a></li>
</ul>
</div>
</div>
<div class="non-sidebar">
<div class="main-content">
<h2>Getting Started</h2>
@ -80,4 +109,4 @@
</div>
</div>
</body>
</html>
</html>

19
samples/swagger-static-docs/docs/models/Category.html
View File

@ -1,12 +1,15 @@
<h2>Category</h2>
<ul class="parameter">
<li class="param-required-">id : long
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">name : string
<br/>{description}}
<ul class="parameter">
<li class="param-required-false">id : Long
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">name : String
<br/>
</li>
</ul>

58
samples/swagger-static-docs/docs/models/Order.html
View File

@ -1,27 +1,39 @@
<h2>Order</h2>
<ul class="parameter">
<li class="param-required-">id : long
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">petId : long
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">quantity : int
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">status : string
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">shipDate : Date
<br/>{description}}
<ul class="parameter">
<li class="param-required-false">id : Long
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">petId : Long
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">quantity : Integer
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">shipDate : Date
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">status : String
<br/>Order Status
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">complete : Boolean
<br/>
</li>
</ul>

63
samples/swagger-static-docs/docs/models/Pet.html
View File

@ -1,32 +1,39 @@
<h2>Pet</h2>
<ul class="parameter">
<li class="param-required-true">id : long
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">category : Category
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-true">name : string
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">photoUrls : List[string]
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">tags : List[Tag]
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">status : string
<br/>{description}}
<ul class="parameter">
<li class="param-required-false">id : Long
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">category : Category
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">name : String
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">photoUrls : List
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">tags : List
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">status : String
<br/>pet status in the store
</li>
</ul>

19
samples/swagger-static-docs/docs/models/Tag.html
View File

@ -1,12 +1,15 @@
<h2>Tag</h2>
<ul class="parameter">
<li class="param-required-">id : long
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">name : string
<br/>{description}}
<ul class="parameter">
<li class="param-required-false">id : Long
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">name : String
<br/>
</li>
</ul>

85
samples/swagger-static-docs/docs/models/User.html
View File

@ -1,42 +1,51 @@
<h2>User</h2>
<ul class="parameter">
<li class="param-required-">id : long
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">firstName : string
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">username : string
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">lastName : string
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">email : string
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">password : string
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">phone : string
<br/>{description}}
</li>
</ul>
<ul class="parameter">
<li class="param-required-">userStatus : int
<br/>{description}}
<ul class="parameter">
<li class="param-required-false">id : Long
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">username : String
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">firstName : String
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">lastName : String
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">email : String
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">password : String
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">phone : String
<br/>
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">userStatus : Integer
<br/>User Status
</li>
</ul>

277
samples/swagger-static-docs/docs/operations/PetApi.html
View File

@ -1,191 +1,140 @@
<div class="main-content">
<h2><a name="PetApi"></a>PetApi</h2>
<p>This is the PetApi API</p>
<h2><a name=""></a></h2>
<p>This is the API</p>
<h2><a name="updatePet"></a>updatePet</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>/pet</code>
<h3 class="section">HTTP Method</h3>
<code>PUT</code>
<h3 class="section">Response Type</h3>
<div class="model" id=""><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">Pet object that needs to be added to the store</p>
</div>
</ul>
<h2><a name="addPet"></a>addPet</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>/pet</code>
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" id=""><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">Pet object that needs to be added to the store</p>
</div>
</ul>
<h2><a name="findPetsByStatus"></a>findPetsByStatus</h2>
<hr>
<p></p>
<p>Multiple status values can be provided with comma seperated strings</p>
<h3 class="section">URL</h3>
<code>/pet/findByStatus</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" id="Pet"><a href="#">List</a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">status&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">Status values that need to be considered for filter</p>
</div>
</ul>
<h2><a name="findPetsByTags"></a>findPetsByTags</h2>
<hr>
<p></p>
<p>Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.</p>
<h3 class="section">URL</h3>
<code>/pet/findByTags</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" id="Pet"><a href="#">List</a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">tags&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">Tags to filter by</p>
</div>
</ul>
<h2><a name="getPetById"></a>getPetById</h2>
<hr>
<p></p>
<p>Returns a pet based on ID</p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/pet/{petId}</code>
<p>Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions</p>
<h3 class="section">URL</h3>
<code>/pet/{petId}</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" id="Pet"><a href="#">Pet</a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">petId&nbsp;:&nbsp;long&nbsp;(path)</div>
<div class="parameter">
<div class="param">petId&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">ID of pet that needs to be fetched</p>
</div>
</ul>
</ul>
<h2><a name="deletePet"></a>deletePet</h2>
<hr>
<p></p>
<p></p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/pet/{petId}</code>
<p></p>
<h3 class="section">URL</h3>
<code>/pet/{petId}</code>
<h3 class="section">HTTP Method</h3>
<code>DELETE</code>
<h3 class="section">Response Type</h3>
<div class="model" id="void"><a href="#"></a></div>
<div class="model" id=""><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">petId&nbsp;:&nbsp;string&nbsp;(path)</div>
<div class="parameter">
<div class="param">petId&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">Pet id to delete</p>
</div>
</ul>
<h2><a name="partialUpdate"></a>partialUpdate</h2>
<hr>
<p></p>
<p></p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/pet/{petId}</code>
<h3 class="section">HTTP Method</h3>
<code>PATCH</code>
<h3 class="section">Response Type</h3>
<div class="model" id="Pet"><a href="#">Array[Pet]</a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">petId&nbsp;:&nbsp;string&nbsp;(path)</div>
<span></span>
</div>
<p class="param-description">ID of pet that needs to be fetched</p>
</div>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;<div class="model" id="Pet"><a href="#">Pet</a>&nbsp;(body)</div>
<span></span>
</div>
<p class="param-description">Pet object that needs to be added to the store</p>
</div>
</ul>
<h2><a name="updatePetWithForm"></a>updatePetWithForm</h2>
<hr>
<p></p>
<p></p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/pet/{petId}</code>
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" id="void"><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">petId&nbsp;:&nbsp;string&nbsp;(path)</div>
<span></span>
</div>
<p class="param-description">ID of pet that needs to be updated</p>
</div>
<div class="parameter">
<div class="param">name&nbsp;:&nbsp;string&nbsp;(form)</div>
<span>optional</span>
</div>
<p class="param-description">Updated name of the pet</p>
</div>
<div class="parameter">
<div class="param">status&nbsp;:&nbsp;string&nbsp;(form)</div>
<span>optional</span>
</div>
<p class="param-description">Updated status of the pet</p>
</div>
</ul>
<h2><a name="uploadFile"></a>uploadFile</h2>
<hr>
<p></p>
<p></p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/pet/uploadImage</code>
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" id="void"><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">additionalMetadata&nbsp;:&nbsp;string&nbsp;(form)</div>
<span>optional</span>
</div>
<p class="param-description">Additional data to pass to server</p>
</div>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;<div class="model" id="File"><a href="#">File</a>&nbsp;(body)</div>
<span>optional</span>
</div>
<p class="param-description">file to upload</p>
</div>
</ul>
<h2><a name="addPet"></a>addPet</h2>
<hr>
<p></p>
<p></p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/pet</code>
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" id="void"><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;<div class="model" id="Pet"><a href="#">Pet</a>&nbsp;(body)</div>
<span></span>
</div>
<p class="param-description">Pet object that needs to be added to the store</p>
</div>
</ul>
<h2><a name="updatePet"></a>updatePet</h2>
<hr>
<p></p>
<p></p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/pet</code>
<h3 class="section">HTTP Method</h3>
<code>PUT</code>
<h3 class="section">Response Type</h3>
<div class="model" id="void"><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;<div class="model" id="Pet"><a href="#">Pet</a>&nbsp;(body)</div>
<span></span>
</div>
<p class="param-description">Pet object that needs to be updated in the store</p>
</div>
</ul>
<h2><a name="findPetsByStatus"></a>findPetsByStatus</h2>
<hr>
<p></p>
<p>Multiple status values can be provided with comma seperated strings</p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/pet/findByStatus</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" id="Pet"><a href="#">Array[Pet]</a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">status&nbsp;:&nbsp;string&nbsp;(query)</div>
<span></span>
</div>
<p class="param-description">Status values that need to be considered for filter</p>
</div>
</ul>
<h2><a name="findPetsByTags"></a>findPetsByTags</h2>
<hr>
<p></p>
<p>Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.</p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/pet/findByTags</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" id="Pet"><a href="#">Array[Pet]</a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">tags&nbsp;:&nbsp;string&nbsp;(query)</div>
<span></span>
</div>
<p class="param-description">Tags to filter by</p>
</div>
</ul>
</div>
</ul>
</div>

79
samples/swagger-static-docs/docs/operations/StoreApi.html
View File

@ -1,59 +1,74 @@
<div class="main-content">
<h2><a name="StoreApi"></a>StoreApi</h2>
<p>This is the StoreApi API</p>
<h2><a name=""></a></h2>
<p>This is the API</p>
<h2><a name="placeOrder"></a>placeOrder</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>/store/order</code>
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" id="Order"><a href="#">Order</a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">order placed for purchasing the pet</p>
</div>
</ul>
<h2><a name="getOrderById"></a>getOrderById</h2>
<hr>
<p></p>
<p>For valid response try integer IDs with value &lt;= 5. Anything above 5 or nonintegers will generate API errors</p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/store/order/{orderId}</code>
<p>For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values will generated exceptions</p>
<h3 class="section">URL</h3>
<code>/store/order/{orderId}</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" id="Order"><a href="#">Order</a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">orderId&nbsp;:&nbsp;string&nbsp;(path)</div>
<div class="parameter">
<div class="param">orderId&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">ID of pet that needs to be fetched</p>
</div>
</ul>
</ul>
<h2><a name="deleteOrder"></a>deleteOrder</h2>
<hr>
<p></p>
<p>For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors</p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/store/order/{orderId}</code>
<p>For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors</p>
<h3 class="section">URL</h3>
<code>/store/order/{orderId}</code>
<h3 class="section">HTTP Method</h3>
<code>DELETE</code>
<h3 class="section">Response Type</h3>
<div class="model" id="void"><a href="#"></a></div>
<div class="model" id=""><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">orderId&nbsp;:&nbsp;string&nbsp;(path)</div>
<div class="parameter">
<div class="param">orderId&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">ID of the order that needs to be deleted</p>
</div>
</ul>
<h2><a name="placeOrder"></a>placeOrder</h2>
<hr>
<p></p>
<p></p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/store/order</code>
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" id="void"><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;<div class="model" id="Order"><a href="#">Order</a>&nbsp;(body)</div>
<span></span>
</div>
<p class="param-description">order placed for purchasing the pet</p>
</div>
</ul>
</div>
</ul>
</div>

240
samples/swagger-static-docs/docs/operations/UserApi.html
View File

@ -1,155 +1,191 @@
<div class="main-content">
<h2><a name="UserApi"></a>UserApi</h2>
<p>This is the UserApi API</p>
<h2><a name=""></a></h2>
<p>This is the API</p>
<h2><a name="updateUser"></a>updateUser</h2>
<h2><a name="createUser"></a>createUser</h2>
<hr>
<p></p>
<p>This can only be done by the logged in user.</p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/user/{username}</code>
<p>This can only be done by the logged in user.</p>
<h3 class="section">URL</h3>
<code>/user</code>
<h3 class="section">HTTP Method</h3>
<code>PUT</code>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" id="void"><a href="#"></a></div>
<div class="model" id=""><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">username&nbsp;:&nbsp;string&nbsp;(path)</div>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">name that need to be deleted</p>
<p class="param-description">Created user object</p>
</div>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;<div class="model" id="User"><a href="#">User</a>&nbsp;(body)</div>
<span></span>
</div>
<p class="param-description">Updated user object</p>
</div>
</ul>
<h2><a name="deleteUser"></a>deleteUser</h2>
</ul>
<h2><a name="createUsersWithArrayInput"></a>createUsersWithArrayInput</h2>
<hr>
<p></p>
<p>This can only be done by the logged in user.</p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/user/{username}</code>
<p></p>
<h3 class="section">URL</h3>
<code>/user/createWithArray</code>
<h3 class="section">HTTP Method</h3>
<code>DELETE</code>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" id="void"><a href="#"></a></div>
<div class="model" id=""><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">username&nbsp;:&nbsp;string&nbsp;(path)</div>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">The name that needs to be deleted</p>
<p class="param-description">List of user object</p>
</div>
</ul>
</ul>
<h2><a name="createUsersWithListInput"></a>createUsersWithListInput</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>/user/createWithList</code>
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" id=""><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">List of user object</p>
</div>
</ul>
<h2><a name="loginUser"></a>loginUser</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>/user/login</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" id="string"><a href="#">String</a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">username&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">The user name for login</p>
</div>
<div class="parameter">
<div class="param">password&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">The password for login in clear text</p>
</div>
</ul>
<h2><a name="logoutUser"></a>logoutUser</h2>
<hr>
<p></p>
<p></p>
<h3 class="section">URL</h3>
<code>/user/logout</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" id=""><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
</ul>
<h2><a name="getUserByName"></a>getUserByName</h2>
<hr>
<p></p>
<p></p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/user/{username}</code>
<p></p>
<h3 class="section">URL</h3>
<code>/user/{username}</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<h3 class="section">Response Type</h3>
<div class="model" id="User"><a href="#">User</a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">username&nbsp;:&nbsp;string&nbsp;(path)</div>
<div class="parameter">
<div class="param">username&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">The name that needs to be fetched. Use user1 for testing.</p>
<p class="param-description">The name that needs to be fetched. Use user1 for testing. </p>
</div>
</ul>
<h2><a name="loginUser"></a>loginUser</h2>
</ul>
<h2><a name="updateUser"></a>updateUser</h2>
<hr>
<p></p>
<p></p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/user/login</code>
<p>This can only be done by the logged in user.</p>
<h3 class="section">URL</h3>
<code>/user/{username}</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<code>PUT</code>
<h3 class="section">Response Type</h3>
<div class="model" id="string"><a href="#">string</a></div>
<div class="model" id=""><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">username&nbsp;:&nbsp;string&nbsp;(query)</div>
<div class="parameter">
<div class="param">username&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">The user name for login</p>
<p class="param-description">name that need to be deleted</p>
</div>
<div class="parameter">
<div class="param">password&nbsp;:&nbsp;string&nbsp;(query)</div>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">The password for login in clear text</p>
<p class="param-description">Updated user object</p>
</div>
</ul>
<h2><a name="logoutUser"></a>logoutUser</h2>
</ul>
<h2><a name="deleteUser"></a>deleteUser</h2>
<hr>
<p></p>
<p></p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/user/logout</code>
<p>This can only be done by the logged in user.</p>
<h3 class="section">URL</h3>
<code>/user/{username}</code>
<h3 class="section">HTTP Method</h3>
<code>GET</code>
<code>DELETE</code>
<h3 class="section">Response Type</h3>
<div class="model" id="void"><a href="#"></a></div>
<div class="model" id=""><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
</ul>
<h2><a name="createUser"></a>createUser</h2>
<hr>
<p></p>
<p>This can only be done by the logged in user.</p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/user</code>
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" id="void"><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;<div class="model" id="User"><a href="#">User</a>&nbsp;(body)</div>
<div class="parameter">
<div class="param">username&nbsp;:&nbsp;&nbsp;()</div>
<span></span>
</div>
<p class="param-description">Created user object</p>
<p class="param-description">The name that needs to be deleted</p>
</div>
</ul>
<h2><a name="createUsersWithArrayInput"></a>createUsersWithArrayInput</h2>
<hr>
<p></p>
<p></p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/user/createWithArray</code>
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" id="void"><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;<div class="model" id="User"><a href="#">Array[User]</a>&nbsp;(body)</div>
<span></span>
</div>
<p class="param-description">List of user object</p>
</div>
</ul>
<h2><a name="createUsersWithListInput"></a>createUsersWithListInput</h2>
<hr>
<p></p>
<p></p><h3 class="section">URL</h3>
<code>http://petstore.swagger.wordnik.com/api/user/createWithList</code>
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" id="void"><a href="#"></a></div>
<h3 class="section">Parameters</h3>
<ul>
<div class="parameter">
<div class="param">body&nbsp;:&nbsp;&nbsp;<div class="model" id="User"><a href="#">Array[User]</a>&nbsp;(body)</div>
<span></span>
</div>
<p class="param-description">List of user object</p>
</div>
</ul>
</div>
</ul>
</div>

1
samples/swagger-static-docs/main.js
View File

@ -5,4 +5,3 @@ var docs_handler = express.static(__dirname + '/docs/');
app.use(docs_handler);
// start the server
app.listen(8002);

1
samples/swagger-static-docs/package.json
View File

@ -10,4 +10,3 @@
},
"license": "apache 2.0"
}