Document schema Namespacing with annotated controllers
Closes gh-863
This commit is contained in:
@@ -0,0 +1,20 @@
|
||||
/*
|
||||
* Copyright 2020-2024 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.graphql.docs.controllers.namespacing;
|
||||
|
||||
public record Album(String id, String title) {
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
/*
|
||||
* Copyright 2020-2024 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.graphql.docs.controllers.namespacing;
|
||||
|
||||
public record Artist(String id, String name) {
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
/*
|
||||
* Copyright 2020-2024 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.graphql.docs.controllers.namespacing;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import org.springframework.graphql.data.method.annotation.Argument;
|
||||
import org.springframework.graphql.data.method.annotation.QueryMapping;
|
||||
import org.springframework.graphql.data.method.annotation.SchemaMapping;
|
||||
import org.springframework.stereotype.Controller;
|
||||
|
||||
@Controller
|
||||
@SchemaMapping(typeName="MusicQueries") // <1>
|
||||
public class MusicController {
|
||||
|
||||
@QueryMapping // <2>
|
||||
public MusicQueries music() {
|
||||
return new MusicQueries();
|
||||
}
|
||||
|
||||
// <3>
|
||||
public record MusicQueries() {
|
||||
|
||||
}
|
||||
|
||||
@SchemaMapping // <4>
|
||||
public Album album(@Argument String id) {
|
||||
return new Album(id, "Spring GraphQL");
|
||||
}
|
||||
|
||||
@SchemaMapping
|
||||
public List<Artist> searchForArtist(@Argument String name) {
|
||||
return List.of(new Artist("100", "the Spring team"));
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
/*
|
||||
* Copyright 2020-2024 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.graphql.docs.controllers.namespacing;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
|
||||
import org.springframework.boot.autoconfigure.graphql.GraphQlSourceBuilderCustomizer;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
|
||||
|
||||
@Configuration
|
||||
public class NamespaceConfiguration {
|
||||
|
||||
@Bean
|
||||
public GraphQlSourceBuilderCustomizer customizer() {
|
||||
List<String> queryWrappers = List.of("music", "users"); // <1>
|
||||
return sourceBuilder -> sourceBuilder.configureRuntimeWiring(wiringBuilder -> {
|
||||
queryWrappers.forEach(field -> wiringBuilder.type("Query",
|
||||
builder -> builder.dataFetcher(field, env -> Collections.emptyMap()))); // <2>
|
||||
});
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
type Query {
|
||||
music: MusicQueries
|
||||
users: UserQueries
|
||||
}
|
||||
|
||||
type MusicQueries {
|
||||
album(id: ID!): Album
|
||||
searchForArtist(name: String!): [Artist]
|
||||
}
|
||||
|
||||
type Album {
|
||||
id: ID!
|
||||
title: String!
|
||||
}
|
||||
|
||||
type Artist {
|
||||
id: ID!
|
||||
name: String!
|
||||
}
|
||||
|
||||
type UserQueries {
|
||||
user(login: String): User
|
||||
}
|
||||
|
||||
type User {
|
||||
id: ID!
|
||||
login: String!
|
||||
}
|
||||
Reference in New Issue
Block a user