commit
e072772bb6
|
@ -9,8 +9,3 @@ This module contains articles about the improvements to core Java features intro
|
||||||
- [Java 9 Stream API Improvements](https://www.baeldung.com/java-9-stream-api)
|
- [Java 9 Stream API Improvements](https://www.baeldung.com/java-9-stream-api)
|
||||||
- [Java 9 java.util.Objects Additions](https://www.baeldung.com/java-9-objects-new)
|
- [Java 9 java.util.Objects Additions](https://www.baeldung.com/java-9-objects-new)
|
||||||
- [Java 9 CompletableFuture API Improvements](https://www.baeldung.com/java-9-completablefuture)
|
- [Java 9 CompletableFuture API Improvements](https://www.baeldung.com/java-9-completablefuture)
|
||||||
|
|
||||||
#### Relevant articles not in this module:
|
|
||||||
|
|
||||||
- [Java 9 Process API Improvements](https://www.baeldung.com/java-9-process-api) (see the [core-java-os](/core-java-os) module)
|
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,3 @@
|
||||||
## Custom PMD Rules
|
## Custom PMD Rules
|
||||||
|
|
||||||
This module contains articles about PMD
|
This module contains articles about PMD
|
||||||
|
|
||||||
### Relevant Articles:
|
|
||||||
|
|
||||||
- [Introduction To PMD](https://www.baeldung.com/pmd)
|
|
|
@ -6,5 +6,4 @@ This module contains articles about Domain-driven Design (DDD)
|
||||||
|
|
||||||
- [Persisting DDD Aggregates](https://www.baeldung.com/spring-persisting-ddd-aggregates)
|
- [Persisting DDD Aggregates](https://www.baeldung.com/spring-persisting-ddd-aggregates)
|
||||||
- [Double Dispatch in DDD](https://www.baeldung.com/ddd-double-dispatch)
|
- [Double Dispatch in DDD](https://www.baeldung.com/ddd-double-dispatch)
|
||||||
- [DDD Aggregates and @DomainEvents](https://www.baeldung.com/spring-data-ddd)
|
|
||||||
- [Organizing Layers Using Hexagonal Architecture, DDD, and Spring](https://www.baeldung.com/hexagonal-architecture-ddd-spring)
|
- [Organizing Layers Using Hexagonal Architecture, DDD, and Spring](https://www.baeldung.com/hexagonal-architecture-ddd-spring)
|
||||||
|
|
|
@ -13,5 +13,4 @@ This module contains articles about RxJava.
|
||||||
- [RxJava Maybe](https://www.baeldung.com/rxjava-maybe)
|
- [RxJava Maybe](https://www.baeldung.com/rxjava-maybe)
|
||||||
- [Combining RxJava Completables](https://www.baeldung.com/rxjava-completable)
|
- [Combining RxJava Completables](https://www.baeldung.com/rxjava-completable)
|
||||||
- [RxJava Hooks](https://www.baeldung.com/rxjava-hooks)
|
- [RxJava Hooks](https://www.baeldung.com/rxjava-hooks)
|
||||||
- [Introduction to rxjava-jdbc](https://www.baeldung.com/rxjava-jdbc)
|
|
||||||
- More articles: [[next -->]](/rxjava-2)
|
- More articles: [[next -->]](/rxjava-2)
|
||||||
|
|
|
@ -6,4 +6,4 @@ This module contains articles about Spring Web MVC in Spring Boot projects.
|
||||||
|
|
||||||
- [Functional Controllers in Spring MVC](https://www.baeldung.com/spring-mvc-functional-controllers)
|
- [Functional Controllers in Spring MVC](https://www.baeldung.com/spring-mvc-functional-controllers)
|
||||||
- [Specify an Array of Strings as Body Parameters in Swagger](https://www.baeldung.com/swagger-body-array-of-strings)
|
- [Specify an Array of Strings as Body Parameters in Swagger](https://www.baeldung.com/swagger-body-array-of-strings)
|
||||||
- More articles: [[prev -->]](/spring-boot-mvc)
|
- More articles: [[prev -->]](/spring-boot-modules/spring-boot-mvc)
|
||||||
|
|
|
@ -10,4 +10,4 @@ This module contains articles about Spring Web MVC in Spring Boot projects.
|
||||||
- [A Controller, Service and DAO Example with Spring Boot and JSF](https://www.baeldung.com/jsf-spring-boot-controller-service-dao)
|
- [A Controller, Service and DAO Example with Spring Boot and JSF](https://www.baeldung.com/jsf-spring-boot-controller-service-dao)
|
||||||
- [Setting Up Swagger 2 with a Spring REST API](https://www.baeldung.com/swagger-2-documentation-for-spring-rest-api)
|
- [Setting Up Swagger 2 with a Spring REST API](https://www.baeldung.com/swagger-2-documentation-for-spring-rest-api)
|
||||||
- [Using Spring ResponseEntity to Manipulate the HTTP Response](https://www.baeldung.com/spring-response-entity)
|
- [Using Spring ResponseEntity to Manipulate the HTTP Response](https://www.baeldung.com/spring-response-entity)
|
||||||
- More articles: [[next -->]](/spring-boot-mvc-2)
|
- More articles: [[next -->]](/spring-boot-modules/spring-boot-mvc-2)
|
||||||
|
|
|
@ -1,159 +0,0 @@
|
||||||
## Spring Swagger Codegen API Client
|
|
||||||
|
|
||||||
This module contains the code for [Generate Spring Boot REST Client with Swagger](http://www.baeldung.com/spring-boot-rest-client-swagger-codegen).
|
|
||||||
|
|
||||||
## 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>com.baeldung</groupId>
|
|
||||||
<artifactId>spring-swagger-codegen-api-client</artifactId>
|
|
||||||
<version>0.0.1-SNAPSHOT</version>
|
|
||||||
<scope>compile</scope>
|
|
||||||
</dependency>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Gradle users
|
|
||||||
|
|
||||||
Add this dependency to your project's build file:
|
|
||||||
|
|
||||||
```groovy
|
|
||||||
compile "com.baeldung:spring-swagger-codegen-api-client:0.0.1-SNAPSHOT"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Others
|
|
||||||
|
|
||||||
At first generate the JAR by executing:
|
|
||||||
|
|
||||||
mvn package
|
|
||||||
|
|
||||||
Then manually install the following JARs:
|
|
||||||
|
|
||||||
* target/spring-swagger-codegen-api-client-0.0.1-SNAPSHOT.jar
|
|
||||||
* target/lib/*.jar
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
Please follow the [installation](#installation) instruction and execute the following Java code:
|
|
||||||
|
|
||||||
```java
|
|
||||||
|
|
||||||
import com.baeldung.petstore.client.invoker.*;
|
|
||||||
import com.baeldung.petstore.client.invoker.auth.*;
|
|
||||||
import com.baeldung.petstore.client.model.*;
|
|
||||||
import com.baeldung.petstore.client.api.PetApi;
|
|
||||||
|
|
||||||
import java.io.File;
|
|
||||||
import java.util.*;
|
|
||||||
|
|
||||||
public class PetApiExample {
|
|
||||||
|
|
||||||
public static void main(String[] args) {
|
|
||||||
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
||||||
|
|
||||||
// Configure OAuth2 access token for authorization: petstore_auth
|
|
||||||
OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
|
|
||||||
petstore_auth.setAccessToken("YOUR ACCESS TOKEN");
|
|
||||||
|
|
||||||
PetApi apiInstance = new PetApi();
|
|
||||||
Pet body = new Pet(); // Pet | Pet object that needs to be added to the store
|
|
||||||
try {
|
|
||||||
apiInstance.addPet(body);
|
|
||||||
} catch (ApiException e) {
|
|
||||||
System.err.println("Exception when calling PetApi#addPet");
|
|
||||||
e.printStackTrace();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
## Documentation for API Endpoints
|
|
||||||
|
|
||||||
All URIs are relative to *http://petstore.swagger.io/v2*
|
|
||||||
|
|
||||||
Class | Method | HTTP request | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
*PetApi* | [**addPet**](docs/PetApi.md#addPet) | **POST** /pet | Add a new pet to the store
|
|
||||||
*PetApi* | [**deletePet**](docs/PetApi.md#deletePet) | **DELETE** /pet/{petId} | Deletes a pet
|
|
||||||
*PetApi* | [**findPetsByStatus**](docs/PetApi.md#findPetsByStatus) | **GET** /pet/findByStatus | Finds Pets by status
|
|
||||||
*PetApi* | [**findPetsByTags**](docs/PetApi.md#findPetsByTags) | **GET** /pet/findByTags | Finds Pets by tags
|
|
||||||
*PetApi* | [**getPetById**](docs/PetApi.md#getPetById) | **GET** /pet/{petId} | Find pet by ID
|
|
||||||
*PetApi* | [**updatePet**](docs/PetApi.md#updatePet) | **PUT** /pet | Update an existing pet
|
|
||||||
*PetApi* | [**updatePetWithForm**](docs/PetApi.md#updatePetWithForm) | **POST** /pet/{petId} | Updates a pet in the store with form data
|
|
||||||
*PetApi* | [**uploadFile**](docs/PetApi.md#uploadFile) | **POST** /pet/{petId}/uploadImage | uploads an image
|
|
||||||
*StoreApi* | [**deleteOrder**](docs/StoreApi.md#deleteOrder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
|
|
||||||
*StoreApi* | [**getInventory**](docs/StoreApi.md#getInventory) | **GET** /store/inventory | Returns pet inventories by status
|
|
||||||
*StoreApi* | [**getOrderById**](docs/StoreApi.md#getOrderById) | **GET** /store/order/{orderId} | Find purchase order by ID
|
|
||||||
*StoreApi* | [**placeOrder**](docs/StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet
|
|
||||||
*UserApi* | [**createUser**](docs/UserApi.md#createUser) | **POST** /user | Create user
|
|
||||||
*UserApi* | [**createUsersWithArrayInput**](docs/UserApi.md#createUsersWithArrayInput) | **POST** /user/createWithArray | Creates list of users with given input array
|
|
||||||
*UserApi* | [**createUsersWithListInput**](docs/UserApi.md#createUsersWithListInput) | **POST** /user/createWithList | Creates list of users with given input array
|
|
||||||
*UserApi* | [**deleteUser**](docs/UserApi.md#deleteUser) | **DELETE** /user/{username} | Delete user
|
|
||||||
*UserApi* | [**getUserByName**](docs/UserApi.md#getUserByName) | **GET** /user/{username} | Get user by user name
|
|
||||||
*UserApi* | [**loginUser**](docs/UserApi.md#loginUser) | **GET** /user/login | Logs user into the system
|
|
||||||
*UserApi* | [**logoutUser**](docs/UserApi.md#logoutUser) | **GET** /user/logout | Logs out current logged in user session
|
|
||||||
*UserApi* | [**updateUser**](docs/UserApi.md#updateUser) | **PUT** /user/{username} | Updated user
|
|
||||||
|
|
||||||
|
|
||||||
## Documentation for Models
|
|
||||||
|
|
||||||
- [Category](docs/Category.md)
|
|
||||||
- [ModelApiResponse](docs/ModelApiResponse.md)
|
|
||||||
- [Order](docs/Order.md)
|
|
||||||
- [Pet](docs/Pet.md)
|
|
||||||
- [Tag](docs/Tag.md)
|
|
||||||
- [User](docs/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
|
|
||||||
|
|
||||||
### petstore_auth
|
|
||||||
|
|
||||||
- **Type**: OAuth
|
|
||||||
- **Flow**: implicit
|
|
||||||
- **Authorization URL**: http://petstore.swagger.io/oauth/dialog
|
|
||||||
- **Scopes**:
|
|
||||||
- write:pets: modify pets in your account
|
|
||||||
- read:pets: read your pets
|
|
||||||
|
|
||||||
|
|
||||||
## Recommendation
|
|
||||||
|
|
||||||
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
|
|
||||||
|
|
||||||
## Author
|
|
||||||
|
|
||||||
apiteam@swagger.io
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue