diff --git a/docs/en/src/SUMMARY.md b/docs/en/src/SUMMARY.md index fcc70908..9b0b4213 100644 --- a/docs/en/src/SUMMARY.md +++ b/docs/en/src/SUMMARY.md @@ -23,6 +23,7 @@ - [Cursor connections](cursor_connections.md) - [Error extensions](error_extensions.md) - [Apollo Tracing](apollo_tracing.md) + - [Hide content in introspection](visibility.md) - [Integrations](integrations.md) - [Warp](integrations_to_warp.md) - [Actix-web](integrations_to_actix_web.md) diff --git a/docs/en/src/integrations_to_actix_web.md b/docs/en/src/integrations_to_actix_web.md index 6eebd44c..25a8a2bb 100644 --- a/docs/en/src/integrations_to_actix_web.md +++ b/docs/en/src/integrations_to_actix_web.md @@ -29,7 +29,7 @@ async fn index_ws( req: HttpRequest, payload: web::Payload, ) -> Result { - ws::start_with_protocols(WSSubscription::new(&schema), &["graphql-ws"], &req, payload) + WSSubscription::start(Schema::clone(&*schema), &req, payload) } ``` diff --git a/docs/en/src/visibility.md b/docs/en/src/visibility.md new file mode 100644 index 00000000..1d4cad0e --- /dev/null +++ b/docs/en/src/visibility.md @@ -0,0 +1,44 @@ +# Hide content in introspection + +By default, all types and fields are visible in introspection. But maybe you want to hide some content according to different users to avoid unnecessary misunderstandings. You can add the `visible` attribute to the type or field to do it. + +```rust +use async_graphql::*; + +#[derive(SimpleObject)] +struct MyObj { + // This field will be visible in introspection. + a: i32, + + // This field is always hidden in introspection. + #[graphql(visible = false)] + b: i32, + + // This field calls the `is_admin` function, which + // is visible if the return value is `true`. + #[graphql(visible = "is_admin")] + c: i32, +} + +#[derive(Enum)] +enum MyEnum { + // This item will be visible in introspection. + A, + + // This item is always hidden in introspection. + #[graphql(visible = false)] + B, + + // This item calls the `is_admin` function, which + // is visible if the return value is `true`. + #[graphql(visible = "is_admin")] + C, +} + +struct IsAdmin(bool); + +fn is_admin(ctx: &Context<'_>) -> bool { + ctx.data_unchecked::().0 +} + +``` \ No newline at end of file diff --git a/docs/zh-CN/src/SUMMARY.md b/docs/zh-CN/src/SUMMARY.md index 3409d19b..c7fd1cc6 100644 --- a/docs/zh-CN/src/SUMMARY.md +++ b/docs/zh-CN/src/SUMMARY.md @@ -23,6 +23,7 @@ - [游标连接](cursor_connections.md) - [错误扩展](error_extensions.md) - [Apollo Tracing支持](apollo_tracing.md) + - [在内省中隐藏内容](visibility.md) - [集成到WebServer](integrations.md) - [Warp](integrations_to_warp.md) - [Actix-web](integrations_to_actix_web.md) diff --git a/docs/zh-CN/src/integrations_to_actix_web.md b/docs/zh-CN/src/integrations_to_actix_web.md index 71328035..bb000194 100644 --- a/docs/zh-CN/src/integrations_to_actix_web.md +++ b/docs/zh-CN/src/integrations_to_actix_web.md @@ -26,7 +26,7 @@ async fn index_ws( req: HttpRequest, payload: web::Payload, ) -> Result { - ws::start_with_protocols(WSSubscription::new(&schema), &["graphql-ws"], &req, payload) + WSSubscription::start(Schema::clone(&*schema), &req, payload) } ``` diff --git a/docs/zh-CN/src/visibility.md b/docs/zh-CN/src/visibility.md new file mode 100644 index 00000000..502d6f37 --- /dev/null +++ b/docs/zh-CN/src/visibility.md @@ -0,0 +1,42 @@ +# 在内省中隐藏内容 + +默认情况下，所有类型，字段在内省中都是可见的。但可能你希望根据不同的用户来隐藏一些信息，避免引起不必要的误会。你可以在类型或者字段上添加`visible`属性来做到。 + +```rust +use async_graphql::*; + +#[derive(SimpleObject)] +struct MyObj { + // 这个字段将在内省中可见 + a: i32, + + // 这个字段在内省中总是隐藏 + #[graphql(visible = false)] + b: i32, + + // 这个字段调用`is_admin`函数，如果函数的返回值为`true`则可见 + #[graphql(visible = "is_admin")] + c: i32, +} + +#[derive(Enum)] +enum MyEnum { + // 这个项目将在内省中可见 + A, + + // 这个项目在内省中总是隐藏 + #[graphql(visible = false)] + B, + + // 这个项目调用`is_admin`函数，如果函数的返回值为`true`则可见 + #[graphql(visible = "is_admin")] + C, +} + +struct IsAdmin(bool); + +fn is_admin(ctx: &Context<'_>) -> bool { + ctx.data_unchecked::().0 +} + +``` \ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs index 035742ce..177ad81b 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -244,7 +244,7 @@ pub type FieldResult = Result; /// | cache_control | Object cache control | [`CacheControl`](struct.CacheControl.html) | Y | /// | extends | Add fields to an entity that's defined in another service | bool | Y | /// | use_type_description | Specifies that the description of the type is on the type declaration. [`Description`]()(derive.Description.html) | bool | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Field parameters @@ -260,7 +260,7 @@ pub type FieldResult = Result; /// | provides | Annotate the expected returned fieldset from a field on a base type that is guaranteed to be selectable by the gateway. | string | Y | /// | requires | Annotate the required input fieldset from a base type for a resolver. It is used to develop a query plan where the required fields may not be needed by the client, but the service may need additional information from other services. | string | Y | /// | guard | Field of guard | [`Guard`](guard/trait.Guard.html) | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Field argument parameters @@ -274,8 +274,8 @@ pub type FieldResult = Result; /// | default_with | Expression to generate default value | code string | Y | /// | validator | Input value validator | [`InputValueValidator`](validators/trait.InputValueValidator.html) | Y | /// | key | Is entity key | bool | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | -/// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | +/// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Valid field return types /// @@ -366,7 +366,7 @@ pub use async_graphql_derive::Object; /// | rename_fields | Rename all the fields according to the given case convention. The possible values are "lowercase", "UPPERCASE", "PascalCase", "camelCase", "snake_case", "SCREAMING_SNAKE_CASE".| string | Y | /// | cache_control | Object cache control | [`CacheControl`](struct.CacheControl.html) | Y | /// | extends | Add fields to an entity that's defined in another service | bool | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Field parameters @@ -382,7 +382,7 @@ pub use async_graphql_derive::Object; /// | provides | Annotate the expected returned fieldset from a field on a base type that is guaranteed to be selectable by the gateway. | string | Y | /// | requires | Annotate the required input fieldset from a base type for a resolver. It is used to develop a query plan where the required fields may not be needed by the client, but the service may need additional information from other services. | string | Y | /// | guard | Field of guard | [`Guard`](guard/trait.Guard.html) | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Examples @@ -416,7 +416,7 @@ pub use async_graphql_derive::SimpleObject; /// | name | Enum name | string | Y | /// | rename_items | Rename all the fields according to the given case convention. The possible values are "lowercase", "UPPERCASE", "PascalCase", "camelCase", "snake_case", "SCREAMING_SNAKE_CASE".| string | Y | /// | remote | Derive a remote enum | string | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Item parameters @@ -425,7 +425,7 @@ pub use async_graphql_derive::SimpleObject; /// |-------------|---------------------------|----------|----------| /// | name | Item name | string | Y | /// | deprecation | Item deprecation reason | string | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Examples @@ -475,7 +475,7 @@ pub use async_graphql_derive::Enum; /// |---------------|---------------------------|----------|----------| /// | name | Object name | string | Y | /// | rename_fields | Rename all the fields according to the given case convention. The possible values are "lowercase", "UPPERCASE", "PascalCase", "camelCase", "snake_case", "SCREAMING_SNAKE_CASE".| string | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Field parameters @@ -488,7 +488,7 @@ pub use async_graphql_derive::Enum; /// | default_with | Expression to generate default value | code string | Y | /// | validator | Input value validator | [`InputValueValidator`](validators/trait.InputValueValidator.html) | Y | /// | flatten | Similar to serde (flatten) | boolean | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Examples @@ -538,7 +538,7 @@ pub use async_graphql_derive::InputObject; /// | rename_args | Rename all the arguments according to the given case convention. The possible values are "lowercase", "UPPERCASE", "PascalCase", "camelCase", "snake_case", "SCREAMING_SNAKE_CASE".| string | Y | /// | field | Fields of this Interface | [InterfaceField] | N | /// | extends | Add fields to an entity that's defined in another service | bool | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Field parameters @@ -554,7 +554,7 @@ pub use async_graphql_derive::InputObject; /// | external | Mark a field as owned by another service. This allows service A to use fields from service B while also knowing at runtime the types of that field. | bool | Y | /// | provides | Annotate the expected returned fieldset from a field on a base type that is guaranteed to be selectable by the gateway. | string | Y | /// | requires | Annotate the required input fieldset from a base type for a resolver. It is used to develop a query plan where the required fields may not be needed by the client, but the service may need additional information from other services. | string | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Field argument parameters @@ -567,7 +567,7 @@ pub use async_graphql_derive::InputObject; /// | default | Use `Default::default` for default value | none | Y | /// | default | Argument default value | literal | Y | /// | default_with | Expression to generate default value | code string | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Define an interface @@ -674,7 +674,7 @@ pub use async_graphql_derive::Interface; /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Object name | string | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Item parameters @@ -763,7 +763,7 @@ pub use async_graphql_derive::Union; /// | name | Field name | string | Y | /// | deprecation | Field deprecation reason | string | Y | /// | guard | Field of guard | [`Guard`](guard/trait.Guard.html) | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Field argument parameters @@ -776,7 +776,7 @@ pub use async_graphql_derive::Union; /// | default | Argument default value | literal | Y | /// | default_with | Expression to generate default value | code string | Y | /// | validator | Input value validator | [`InputValueValidator`](validators/trait.InputValueValidator.html) | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Examples @@ -819,7 +819,7 @@ pub use async_graphql_derive::Scalar; /// | cache_control | Object cache control | [`CacheControl`](struct.CacheControl.html) | Y | /// | extends | Add fields to an entity that's defined in another service | bool | Y | /// | use_type_description | Specifies that the description of the type is on the type declaration. [`Description`]()(derive.Description.html) | bool | Y | -/// | visible | If `false`, it will not be displayed in introspection. | bool | Y | +/// | visible | If `false`, it will not be displayed in introspection. *[See also the Book](https://async-graphql.github.io/async-graphql/en/visibility.html).* | bool | Y | /// | visible | Call the specified function. If the return value is `false`, it will not be displayed in introspection. | string | Y | /// /// # Examples