This is a sample server Petstore server. For this sample, you can use the api key special-key to test the authorization filters. For OAuth2 flow, you may use user as both username and password when asked to login.
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
- Build package: org.openapitools.codegen.languages.JuliaClientCodegen
Place the Julia files generated under the src folder in your Julia project. Include PetStoreClient.jl in the project code.
It would include the module named PetStoreClient.
Documentation is generated as markdown files under the docs folder. You can include them in your project documentation.
Documentation is also embedded in Julia which can be used with a Julia specific documentation generator.
| Class | Method |
|---|---|
| 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 | 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 |
Authentication schemes defined for the API:
- Type: OAuth
- Flow: implicit
- Authorization URL: /api/oauth/dialog
- Scopes:
- write:pets: modify pets in your account
- read:pets: read your pets
Example
using OpenAPI
using OpenAPI.Clients
import OpenAPI.Clients: Client, set_header
client = Client(server_uri)
set_header(client, "Authorization", "Bearer $bearer_auth")
api = MyApi(client)
result = callApi(api, args...; api_key)
- Type: API key
Example
using OpenAPI
using OpenAPI.Clients
import OpenAPI.Clients: Client
client = Client(server_uri)
api = MyApi(client)
result = callApi(api, args...; api_key)