Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nkonev/multipart-spring-graphql
Multipart support for Spring GraphQL
https://github.com/nkonev/multipart-spring-graphql
graphql multipart multipart-uploads spring spring-boot spring-graphql springboot
Last synced: 18 days ago
JSON representation
Multipart support for Spring GraphQL
- Host: GitHub
- URL: https://github.com/nkonev/multipart-spring-graphql
- Owner: nkonev
- License: apache-2.0
- Created: 2023-06-28T22:32:39.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-27T03:39:49.000Z (4 months ago)
- Last Synced: 2024-10-12T02:50:28.065Z (about 1 month ago)
- Topics: graphql, multipart, multipart-uploads, spring, spring-boot, spring-graphql, springboot
- Language: Java
- Homepage:
- Size: 165 KB
- Stars: 14
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Multipart Spring GraphQL
Adds [missing](https://github.com/spring-projects/spring-graphql/issues/69) multipart support.
Before using you need to see
* This [comment](https://github.com/spring-projects/spring-graphql/pull/430#issuecomment-1476186878)
* This [explanation](https://www.apollographql.com/blog/backend/file-uploads/file-upload-best-practices/)
## Features
1. `FilePart` arguments for `Webflux` reactive [stack](https://github.com/nkonev/multipart-graphql-demo/tree/master/server-webflux)
```java
@Controller
public class FileController {
private static final Logger logger = LoggerFactory.getLogger(FileController.class);
@MutationMapping(name = "fileUpload")
public FileUploadResult uploadFile(@Argument FilePart file) {
logger.info("Upload file: name={}", file.filename());
return new FileUploadResult(UUID.randomUUID());
}
@MutationMapping(name = "multiFileUpload")
public Collection uploadMultiFiles(@Argument Collection files) {
for (FilePart filePart : files) {
logger.info("Upload file: name={}", filePart.filename());
}
return List.of(new FileUploadResult(UUID.randomUUID()));
}
}
```
2. `MultipartFile` arguments for `WebMVC` servlet [stack](https://github.com/nkonev/multipart-graphql-demo/tree/master/server-webmvc)
```java
@Controller
public class FileController {
private static final Logger logger = LoggerFactory.getLogger(FileController.class);
@MutationMapping(name = "fileUpload")
public FileUploadResult uploadFile(@Argument MultipartFile file) {
logger.info("Upload file: name={}", file.getOriginalFilename());
return new FileUploadResult(UUID.randomUUID());
}
@MutationMapping(name = "multiFileUpload")
public Collection uploadMultiFiles(@Argument Collection files) {
for (MultipartFile file : files) {
logger.info("Upload file: name={}", file.getOriginalFilename());
}
return List.of(new FileUploadResult(UUID.randomUUID()));
}
}
```
3. `WebClient`-based [client](https://github.com/nkonev/multipart-graphql-demo/tree/master/client-webflux)
```java
@Autowired
private MultipartGraphQlWebClient httpGraphQlClient;
@Override
public void run(String... args) {
var doc = """
mutation FileNUpload($files: [Upload!]) {
multiFileUpload(files: $files){
id
}
}
""";
Map fileVariables = singletonMap("files", List.of(
new ClassPathResource("/foo.txt"),
new ClassPathResource("/bar.txt")
));
var request = MultipartClientGraphQlRequest.builder()
.withDocument(doc)
.withFileVariables(fileVariables)
.build();
var response = httpGraphQlClient.executeFileUpload("http://localhost:8899/graphql", request).block();
LOGGER.info("Response is {}", response);
}
```
4. `RestClient`-based [client](https://github.com/nkonev/multipart-graphql-demo/tree/master/client-webmvc)
```java
@Autowired
private MultipartGraphQlRestClient httpGraphQlClient;
@Override
public void run(String... args) {
var doc = """
mutation FileNUpload($files: [Upload!]) {
multiFileUpload(files: $files){
id
}
}
""";
Map fileVariables = singletonMap("files", List.of(
new ClassPathResource("/foo.txt"),
new ClassPathResource("/bar.txt")
));
var request = MultipartClientGraphQlRequest.builder()
.withDocument(doc)
.withFileVariables(fileVariables)
.build();
var response = httpGraphQlClient.executeFileUpload("http://localhost:8889/graphql", request);
LOGGER.info("Response is {}", response);
}
```
## Download
### Spring Boot Starter
```xml
name.nkonev.multipart-spring-graphql
multipart-spring-graphql
VERSION
```
# Compatibility
| multipart-spring-graphql | Java | Spring Boot | Example |
|--------------------------|------|-------------------|--------------------------------------------------------------|
| 0.10.x | 8+ | Spring Boot 2.7.x | https://github.com/nkonev/multipart-graphql-demo/tree/0.10.x |
| 1.0.x | 17+ | Spring Boot 3.0.x | https://github.com/nkonev/multipart-graphql-demo/tree/1.0.x |
| 1.1.x | 17+ | Spring Boot 3.1.x | https://github.com/nkonev/multipart-graphql-demo/tree/1.1.x |
| 1.2.x | 17+ | Spring Boot 3.2.x | https://github.com/nkonev/multipart-graphql-demo/tree/1.2.x |
| 1.3.x | 17+ | Spring Boot 3.3.x | https://github.com/nkonev/multipart-graphql-demo/tree/1.3.x |
| 1.4.x | 17+ | Spring Boot 3.3.x | https://github.com/nkonev/multipart-graphql-demo/tree/1.4.x |