openapi-generator/samples/client/petstore/scala-pekko/README.md

scala-pekko-petstore-client

OpenAPI Petstore

• API version: 1.0.0

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

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle/SBT

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>org.openapitools</groupId>
  <artifactId>scala-pekko-petstore-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "org.openapitools:scala-pekko-petstore-client:1.0.0"

SBT users

libraryDependencies += "org.openapitools" % "scala-pekko-petstore-client" % "1.0.0"

Getting Started

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

import org.openapitools.client.core._
import org.openapitools.client.model._
import org.openapitools.client.api.PetApi

import org.apache.pekko.actor.ActorSystem
import scala.concurrent.Future
import scala.util.{Failure, Success}

object PetApiExample extends App {

    implicit val system: ActorSystem = ActorSystem()
    import system.dispatcher
    
    // Create invoker to execute requests
    val apiInvoker = ApiInvoker()
    val apiInstance = PetApi("https://petstore.swagger.io/v2")
    val pet: Pet =  // Pet | Pet object that needs to be added to the store

    val request = apiInstance.addPet(pet)
    val response = apiInvoker.execute(request)

    response.onComplete {
        case Success(org.openapitools.client.core.ApiResponse(code, content, headers)) =>
            System.out.println(s"Status code: $code}")
            System.out.println(s"Response headers: ${headers.mkString(", ")}")
            System.out.println(s"Response body: $content")

        case Failure(error @ ApiError(code, message, responseContent, cause, headers)) =>
            System.err.println("Exception when calling PetApi#addPet")
            System.err.println(s"Status code: $code}")
            System.err.println(s"Reason: $responseContent")
            System.err.println(s"Response headers: ${headers.mkString(", ")}")
            error.printStackTrace();

        case Failure(exception) =>
            System.err.println("Exception when calling PetApi#addPet")
            exception.printStackTrace();
    }

}

Documentation for API Endpoints

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

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

Documentation for Models

• ApiResponse
• Category
• Order
• Pet
• Tag
• User

Documentation for Authorization

Authentication schemes defined for the API:

api_key

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

auth_cookie

• Type: API key
• API key parameter name: AUTH_KEY
• Location:

Author