This is a sample server Petstore server. For this sample, you can use the api key special-key
to test the authorization filters.
This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.RClientCodegen
Install the dependencies
install.packages("jsonlite")
install.packages("httr")
install.packages("base64enc")
git clone https://github.com/GIT_USER_ID/GIT_REPO_ID
cd GIT_REPO_ID
R CMD build .
R CMD check petstore_1.0.0.tar.gz --no-manual
R CMD INSTALL --preclean petstore_1.0.0.tar.gz
install.packages("petstore")
To install directly from Github, use devtools
:
install.packages("devtools")
library(devtools)
install_github("GIT_USER_ID/GIT_REPO_ID")
To install the package from a local file:
install.packages("petstore_1.0.0.tar.gz", repos = NULL, type = "source")
library(petstore)
All URIs are relative to http://petstore.swagger.io/v2
Class | Method | HTTP request | Description |
---|---|---|---|
FakeApi | fake_data_file | GET /fake/data_file | test data_file to ensure it's escaped correctly |
PetApi | add_pet | POST /pet | Add a new pet to the store |
PetApi | delete_pet | DELETE /pet/{petId} | Deletes a pet |
PetApi | find_pets_by_status | GET /pet/findByStatus | Finds Pets by status |
PetApi | find_pets_by_tags | GET /pet/findByTags | Finds Pets by tags |
PetApi | get_pet_by_id | GET /pet/{petId} | Find pet by ID |
PetApi | get_pet_by_id_streaming | GET /pet/{petId}?streaming | Find pet by ID (streaming) |
PetApi | test_header | GET /pet_header_test | Header test |
PetApi | update_pet | PUT /pet | Update an existing pet |
PetApi | update_pet_with_form | POST /pet/{petId} | Updates a pet in the store with form data |
PetApi | upload_file | POST /pet/{petId}/uploadImage | uploads an image |
StoreApi | delete_order | DELETE /store/order/{orderId} | Delete purchase order by ID |
StoreApi | get_inventory | GET /store/inventory | Returns pet inventories by status |
StoreApi | get_order_by_id | GET /store/order/{orderId} | Find purchase order by ID |
StoreApi | place_order | POST /store/order | Place an order for a pet |
UserApi | create_user | POST /user | Create user |
UserApi | create_users_with_array_input | POST /user/createWithArray | Creates list of users with given input array |
UserApi | create_users_with_list_input | POST /user/createWithList | Creates list of users with given input array |
UserApi | delete_user | DELETE /user/{username} | Delete user |
UserApi | get_user_by_name | GET /user/{username} | Get user by user name |
UserApi | login_user | GET /user/login | Logs user into the system |
UserApi | logout_user | GET /user/logout | Logs out current logged in user session |
UserApi | update_user | PUT /user/{username} | Updated user |
- AllofTagApiResponse
- Animal
- AnyOfPig
- BasquePig
- Cat
- CatAllOf
- Category
- DanishPig
- Dog
- DogAllOf
- ModelApiResponse
- NestedOneOf
- Order
- Pet
- Pig
- Special
- Tag
- UpdatePetRequest
- User
- Type: Bearer authentication
- Type: API key
- API key parameter name: api_key
- Location: HTTP header
- Type: HTTP basic authentication
- 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