forked from loafle/openapi-generator-original
30bd6f680d
* [akka-scala] License info add in template header #7321 * generate petstore by akka-scala teplate
136 lines
5.0 KiB
Markdown
136 lines
5.0 KiB
Markdown
# NAME
|
|
|
|
Swagger Petstore
|
|
|
|
This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.
|
|
|
|
# VERSION
|
|
|
|
Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/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](https://maven.apache.org/) to be installed.
|
|
|
|
## Installation
|
|
|
|
To install the API client library to your local Maven repository, simply execute:
|
|
|
|
```shell
|
|
mvn install
|
|
```
|
|
|
|
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
|
|
|
|
```shell
|
|
mvn deploy
|
|
```
|
|
|
|
Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.
|
|
|
|
### Maven users
|
|
|
|
Add this dependency to your project's POM:
|
|
|
|
```xml
|
|
<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:
|
|
|
|
```groovy
|
|
compile "io.swagger:scala-akka-petstore-client:1.0.0"
|
|
```
|
|
|
|
### SBT users
|
|
|
|
```scala
|
|
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**](PetApi.md#addPet) | **POST** /pet | Add a new pet to the store
|
|
*PetApi* | [**deletePet**](PetApi.md#deletePet) | **DELETE** /pet/{petId} | Deletes a pet
|
|
*PetApi* | [**findPetsByStatus**](PetApi.md#findPetsByStatus) | **GET** /pet/findByStatus | Finds Pets by status
|
|
*PetApi* | [**findPetsByTags**](PetApi.md#findPetsByTags) | **GET** /pet/findByTags | Finds Pets by tags
|
|
*PetApi* | [**getPetById**](PetApi.md#getPetById) | **GET** /pet/{petId} | Find pet by ID
|
|
*PetApi* | [**updatePet**](PetApi.md#updatePet) | **PUT** /pet | Update an existing pet
|
|
*PetApi* | [**updatePetWithForm**](PetApi.md#updatePetWithForm) | **POST** /pet/{petId} | Updates a pet in the store with form data
|
|
*PetApi* | [**uploadFile**](PetApi.md#uploadFile) | **POST** /pet/{petId}/uploadImage | uploads an image
|
|
*StoreApi* | [**deleteOrder**](StoreApi.md#deleteOrder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
|
|
*StoreApi* | [**getInventory**](StoreApi.md#getInventory) | **GET** /store/inventory | Returns pet inventories by status
|
|
*StoreApi* | [**getOrderById**](StoreApi.md#getOrderById) | **GET** /store/order/{orderId} | Find purchase order by ID
|
|
*StoreApi* | [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet
|
|
*UserApi* | [**createUser**](UserApi.md#createUser) | **POST** /user | Create user
|
|
*UserApi* | [**createUsersWithArrayInput**](UserApi.md#createUsersWithArrayInput) | **POST** /user/createWithArray | Creates list of users with given input array
|
|
*UserApi* | [**createUsersWithListInput**](UserApi.md#createUsersWithListInput) | **POST** /user/createWithList | Creates list of users with given input array
|
|
*UserApi* | [**deleteUser**](UserApi.md#deleteUser) | **DELETE** /user/{username} | Delete user
|
|
*UserApi* | [**getUserByName**](UserApi.md#getUserByName) | **GET** /user/{username} | Get user by user name
|
|
*UserApi* | [**loginUser**](UserApi.md#loginUser) | **GET** /user/login | Logs user into the system
|
|
*UserApi* | [**logoutUser**](UserApi.md#logoutUser) | **GET** /user/logout | Logs out current logged in user session
|
|
*UserApi* | [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user
|
|
|
|
|
|
## Documentation for Models
|
|
|
|
- [ApiResponse](ApiResponse.md)
|
|
- [Category](Category.md)
|
|
- [Order](Order.md)
|
|
- [Pet](Pet.md)
|
|
- [Tag](Tag.md)
|
|
- [User](User.md)
|
|
|
|
|
|
## 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
|