ApiOptions

hostname

Set the hostname of the server. If not set, the server will be available on localhost.

port

Which port the Vendure server should listen on.

adminApiPath

The path to the admin GraphQL API.

shopApiPath

The path to the shop GraphQL API.

adminApiPlayground

The playground config to the admin GraphQL API ApolloServer playground.

shopApiPlayground

The playground config to the shop GraphQL API ApolloServer playground.

adminApiDebug

The debug config to the admin GraphQL API ApolloServer playground.

shopApiDebug

The debug config to the shop GraphQL API ApolloServer playground.

shopListQueryLimit

The maximum number of items that may be returned by a query which returns a PaginatedList response. In other words, this is the upper limit of the take input option.

adminListQueryLimit

The maximum number of items that may be returned by a query which returns a PaginatedList response. In other words, this is the upper limit of the take input option.

adminApiValidationRules

Custom functions to use as additional validation rules when validating the schema for the admin GraphQL API ApolloServer validation rules.

shopApiValidationRules

Custom functions to use as additional validation rules when validating the schema for the shop GraphQL API ApolloServer validation rules.

channelTokenKey

The name of the property which contains the token of the active channel. This property can be included either in the request header or as a query string.

cors

Set the CORS handling for the server. See the express CORS docs.

middleware

Custom Express or NestJS middleware for the server. More information can be found in the Middleware docs.

trustProxy

Set the trust proxy configuration for the server. See the express proxy docs.

apolloServerPlugins

Custom ApolloServerPlugins which allow the extension of the Apollo Server, which is the underlying GraphQL server used by Vendure.

Apollo plugins can be used e.g. to perform custom data transformations on incoming operations or outgoing data.

introspection

Controls whether introspection of the GraphQL APIs is enabled. For production, it is recommended to disable introspection, since exposing your entire schema can allow an attacker to trivially learn all operations and much more easily find any potentially exploitable queries.

Note: when introspection is disabled, tooling which relies on it for things like autocompletion will not work.

Example

{  introspection: process.env.NODE_ENV !== 'production'}