openapi-generator/samples/client/petstore/akka-scala

NAME

Swagger Petstore

This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key special-key to test the authorization filters.

VERSION

Automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version:
• Build date: 2018-01-05T12:13:52.852+08:00
• Build package: io.swagger.codegen.languages.AkkaScalaClientCodegen

Requirements

Building the API client library requires Maven to be installed.

Installation

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

mvn install

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

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>scala-akka-petstore-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:scala-akka-petstore-client:1.0.0"

SBT users

libraryDependencies += "io.swagger" % "scala-akka-petstore-client" % "1.0.0"

Documentation for API Endpoints

All URIs are relative to http://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

BUILDING YOUR LIBRARY

See the homepage https://github.com/swagger-api/swagger-codegen for full details. But briefly, clone the git repository, build the codegen codebase, set up your build config file, then run the API build script. You will need git, Java 7 or 8 and Apache maven 3.0.3 or better already installed.

Your library files will be built under WWW::MyProjectName.

      $ git clone https://github.com/swagger-api/swagger-codegen.git
      $ cd swagger-codegen
      $ mvn package
      $ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
-i [URL or file path to JSON swagger API spec] \
-l akka-scala \
-c /path/to/config/file.json \
-o /path/to/output/folder

Bang, all done. Run the autodoc script in the bin directory to see the API you just built.

Author

apiteam@swagger.io