openapi-generator/samples/client/petstore/apex

OpenAPI Petstore API Client

This is a sample server Petstore server. For this sample, you can use the api key special-key to test the authorization filters.

Requirements

• Salesforce DX

If everything is set correctly:

• Running sfdx version in a command prompt should output something like:

  sfdx-cli/5.7.5-05549de (darwin-amd64) go1.7.5 sfdxstable
  

Installation

1. Copy the output into your Salesforce DX folder - or alternatively deploy the output directly into the workspace.

2. Deploy the code via Salesforce DX to your Scratch Org

      sfdx force:source:push
   

3. If the API needs authentication update the Named Credential in Setup.

4. Run your Apex tests using

       sfdx sfdx force:apex:test:run
   

5. Retrieve the job id from the console and check the test results.

sfdx force:apex:test:report -i theJobId

Getting Started

Please follow the installation instruction and execute the following Apex code:

OASPetApi api = new OASPetApi();
OASClient client = api.getClient();


Map<String, Object> params = new Map<String, Object>{
    'oaSPet' => ''
};

try {
    // cross your fingers
    OASPet result = api.addPet(params);
    System.debug(result);
} catch (OAS.ApiException e) {
    // ...handle your exceptions
}

Documentation for API Endpoints

All URIs are relative to http://petstore.swagger.io/v2

Class	Method	HTTP request	Description
OASPetApi	addPet	POST /pet	Add a new pet to the store
OASPetApi	deletePet	DELETE /pet/{petId}	Deletes a pet
OASPetApi	findPetsByStatus	GET /pet/findByStatus	Finds Pets by status
OASPetApi	findPetsByTags	GET /pet/findByTags	Finds Pets by tags
OASPetApi	getPetById	GET /pet/{petId}	Find pet by ID
OASPetApi	updatePet	PUT /pet	Update an existing pet
OASPetApi	updatePetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
OASPetApi	uploadFile	POST /pet/{petId}/uploadImage	uploads an image
OASStoreApi	deleteOrder	DELETE /store/order/{orderId}	Delete purchase order by ID
OASStoreApi	getInventory	GET /store/inventory	Returns pet inventories by status
OASStoreApi	getOrderById	GET /store/order/{orderId}	Find purchase order by ID
OASStoreApi	placeOrder	POST /store/order	Place an order for a pet
OASUserApi	createUser	POST /user	Create user
OASUserApi	createUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
OASUserApi	createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
OASUserApi	deleteUser	DELETE /user/{username}	Delete user
OASUserApi	getUserByName	GET /user/{username}	Get user by user name
OASUserApi	loginUser	GET /user/login	Logs user into the system
OASUserApi	logoutUser	GET /user/logout	Logs out current logged in user session
OASUserApi	updateUser	PUT /user/{username}	Updated user

Documentation for Models

• OASApiResponse
• OASCategory
• OASInlineObject
• OASInlineObject1
• OASOrder
• OASPet
• OASTag
• OASUser

Documentation for Authorization

Authentication schemes defined for the API:

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header

petstore_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: http://petstore.swagger.io/api/oauth/dialog
• Scopes:
  • write:pets: modify pets in your account
  • read:pets: read your pets

Author