loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

update php documentation

Browse Source
This commit is contained in:
William Cheng 2015-03-27 22:40:59 +08:00
parent 3d12c8847f
commit 1c547e9598
4 changed files with 68 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
modules/swagger-codegen/src/main/resources/php/api.mustache
View File

@ -31,11 +31,10 @@ class {{classname}} {
* {{{nickname}}} * {{{nickname}}}
* *
* {{{summary}}} * {{{summary}}}
{{#allParams}}* {{paramName}}, {{dataType}}: {{description}} {{^optional}}(required){{/optional}}{{#optional}}(optional){{/optional}} *
* {{/allParams}} {{#allParams}} * @param {{dataType}} ${{paramName}} {{description}} {{^optional}}(required){{/optional}}{{#optional}}(optional){{/optional}}
* @return {{{returnType}}} {{/allParams}} * @return {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}
*/ */
public function {{nickname}}({{#allParams}}${{paramName}}{{#optional}}=null{{/optional}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) { public function {{nickname}}({{#allParams}}${{paramName}}{{#optional}}=null{{/optional}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) {
// parse inputs // parse inputs

66
samples/client/petstore/php/PetApi.php
View File

@ -30,11 +30,10 @@ class PetApi {
* updatePet * updatePet
* *
* Update an existing pet * Update an existing pet
* body, Pet: Pet object that needs to be added to the store (required) *
* * @param Pet $body Pet object that needs to be added to the store (required)
* @return * @return void
*/ */
public function updatePet($body) { public function updatePet($body) {
// parse inputs // parse inputs
@ -76,11 +75,10 @@ class PetApi {
* addPet * addPet
* *
* Add a new pet to the store * Add a new pet to the store
* body, Pet: Pet object that needs to be added to the store (required) *
* * @param Pet $body Pet object that needs to be added to the store (required)
* @return * @return void
*/ */
public function addPet($body) { public function addPet($body) {
// parse inputs // parse inputs
@ -122,11 +120,10 @@ class PetApi {
* findPetsByStatus * findPetsByStatus
* *
* Finds Pets by status * Finds Pets by status
* status, array[string]: Status values that need to be considered for filter (required) *
* * @param array[string] $status Status values that need to be considered for filter (required)
* @return array[Pet] * @return array[Pet]
*/ */
public function findPetsByStatus($status) { public function findPetsByStatus($status) {
// parse inputs // parse inputs
@ -173,11 +170,10 @@ class PetApi {
* findPetsByTags * findPetsByTags
* *
* Finds Pets by tags * Finds Pets by tags
* tags, array[string]: Tags to filter by (required) *
* * @param array[string] $tags Tags to filter by (required)
* @return array[Pet] * @return array[Pet]
*/ */
public function findPetsByTags($tags) { public function findPetsByTags($tags) {
// parse inputs // parse inputs
@ -224,11 +220,10 @@ class PetApi {
* getPetById * getPetById
* *
* Find pet by ID * Find pet by ID
* pet_id, int: ID of pet that needs to be fetched (required) *
* * @param int $pet_id ID of pet that needs to be fetched (required)
* @return Pet * @return Pet
*/ */
public function getPetById($pet_id) { public function getPetById($pet_id) {
// parse inputs // parse inputs
@ -276,13 +271,12 @@ class PetApi {
* updatePetWithForm * updatePetWithForm
* *
* Updates a pet in the store with form data * Updates a pet in the store with form data
* pet_id, string: ID of pet that needs to be updated (required) *
* * name, string: Updated name of the pet (required) * @param string $pet_id ID of pet that needs to be updated (required)
* * status, string: Updated status of the pet (required) * @param string $name Updated name of the pet (required)
* * @param string $status Updated status of the pet (required)
* @return * @return void
*/ */
public function updatePetWithForm($pet_id, $name, $status) { public function updatePetWithForm($pet_id, $name, $status) {
// parse inputs // parse inputs
@ -330,12 +324,11 @@ class PetApi {
* deletePet * deletePet
* *
* Deletes a pet * Deletes a pet
* api_key, string: (required) *
* * pet_id, int: Pet id to delete (required) * @param string $api_key (required)
* * @param int $pet_id Pet id to delete (required)
* @return * @return void
*/ */
public function deletePet($api_key, $pet_id) { public function deletePet($api_key, $pet_id) {
// parse inputs // parse inputs
@ -380,13 +373,12 @@ class PetApi {
* uploadFile * uploadFile
* *
* uploads an image * uploads an image
* pet_id, int: ID of pet to update (required) *
* * additional_metadata, string: Additional data to pass to server (required) * @param int $pet_id ID of pet to update (required)
* * file, file: file to upload (required) * @param string $additional_metadata Additional data to pass to server (required)
* * @param file $file file to upload (required)
* @return * @return void
*/ */
public function uploadFile($pet_id, $additional_metadata, $file) { public function uploadFile($pet_id, $additional_metadata, $file) {
// parse inputs // parse inputs

26
samples/client/petstore/php/StoreApi.php
View File

@ -30,10 +30,9 @@ class StoreApi {
* getInventory * getInventory
* *
* Returns pet inventories by status * Returns pet inventories by status
*
* @return map[string,int] * @return map[string,int]
*/ */
public function getInventory() { public function getInventory() {
// parse inputs // parse inputs
@ -77,11 +76,10 @@ class StoreApi {
* placeOrder * placeOrder
* *
* Place an order for a pet * Place an order for a pet
* body, Order: order placed for purchasing the pet (required) *
* * @param Order $body order placed for purchasing the pet (required)
* @return Order * @return Order
*/ */
public function placeOrder($body) { public function placeOrder($body) {
// parse inputs // parse inputs
@ -129,11 +127,10 @@ class StoreApi {
* getOrderById * getOrderById
* *
* Find purchase order by ID * Find purchase order by ID
* order_id, string: ID of pet that needs to be fetched (required) *
* * @param string $order_id ID of pet that needs to be fetched (required)
* @return Order * @return Order
*/ */
public function getOrderById($order_id) { public function getOrderById($order_id) {
// parse inputs // parse inputs
@ -181,11 +178,10 @@ class StoreApi {
* deleteOrder * deleteOrder
* *
* Delete purchase order by ID * Delete purchase order by ID
* order_id, string: ID of the order that needs to be deleted (required) *
* * @param string $order_id ID of the order that needs to be deleted (required)
* @return * @return void
*/ */
public function deleteOrder($order_id) { public function deleteOrder($order_id) {
// parse inputs // parse inputs

58
samples/client/petstore/php/UserApi.php
View File

@ -30,11 +30,10 @@ class UserApi {
* createUser * createUser
* *
* Create user * Create user
* body, User: Created user object (required) *
* * @param User $body Created user object (required)
* @return * @return void
*/ */
public function createUser($body) { public function createUser($body) {
// parse inputs // parse inputs
@ -76,11 +75,10 @@ class UserApi {
* createUsersWithArrayInput * createUsersWithArrayInput
* *
* Creates list of users with given input array * Creates list of users with given input array
* body, array[User]: List of user object (required) *
* * @param array[User] $body List of user object (required)
* @return * @return void
*/ */
public function createUsersWithArrayInput($body) { public function createUsersWithArrayInput($body) {
// parse inputs // parse inputs
@ -122,11 +120,10 @@ class UserApi {
* createUsersWithListInput * createUsersWithListInput
* *
* Creates list of users with given input array * Creates list of users with given input array
* body, array[User]: List of user object (required) *
* * @param array[User] $body List of user object (required)
* @return * @return void
*/ */
public function createUsersWithListInput($body) { public function createUsersWithListInput($body) {
// parse inputs // parse inputs
@ -168,12 +165,11 @@ class UserApi {
* loginUser * loginUser
* *
* Logs user into the system * Logs user into the system
* username, string: The user name for login (required) *
* * password, string: The password for login in clear text (required) * @param string $username The user name for login (required)
* * @param string $password The password for login in clear text (required)
* @return string * @return string
*/ */
public function loginUser($username, $password) { public function loginUser($username, $password) {
// parse inputs // parse inputs
@ -223,10 +219,9 @@ class UserApi {
* logoutUser * logoutUser
* *
* Logs out current logged in user session * Logs out current logged in user session
*
* @return * @return void
*/ */
public function logoutUser() { public function logoutUser() {
// parse inputs // parse inputs
@ -264,11 +259,10 @@ class UserApi {
* getUserByName * getUserByName
* *
* Get user by user name * Get user by user name
* username, string: The name that needs to be fetched. Use user1 for testing. (required) *
* * @param string $username The name that needs to be fetched. Use user1 for testing. (required)
* @return User * @return User
*/ */
public function getUserByName($username) { public function getUserByName($username) {
// parse inputs // parse inputs
@ -316,12 +310,11 @@ class UserApi {
* updateUser * updateUser
* *
* Updated user * Updated user
* username, string: name that need to be deleted (required) *
* * body, User: Updated user object (required) * @param string $username name that need to be deleted (required)
* * @param User $body Updated user object (required)
* @return * @return void
*/ */
public function updateUser($username, $body) { public function updateUser($username, $body) {
// parse inputs // parse inputs
@ -367,11 +360,10 @@ class UserApi {
* deleteUser * deleteUser
* *
* Delete user * Delete user
* username, string: The name that needs to be deleted (required) *
* * @param string $username The name that needs to be deleted (required)
* @return * @return void
*/ */
public function deleteUser($username) { public function deleteUser($username) {
// parse inputs // parse inputs