OpenApiConfig constructor

const OpenApiConfig({
  1. bool? enabled,
  2. Info info = const Info(title: 'Dox API', version: '1.0.0'),
  3. List<Server> servers = const <Server>[],
  4. Map<String, SecurityScheme> securitySchemes = const <String, SecurityScheme>{},
  5. Map<String, List<Map<String, List<String>>>> securityByMiddleware = const <String, List<Map<String, List<String>>>>{},
  6. OpenApiRegistry registry = const OpenApiRegistry(),
  7. DocsUi ui = DocsUi.scalar,
  8. ScalarOptions scalar = const ScalarOptions(),
  9. String? pageTitle,
  10. List<String> include = const <String>[],
  11. List<String> exclude = const <String>[],
})

Implementation

const OpenApiConfig({
  this.enabled,
  this.info = const Info(title: 'Dox API', version: '1.0.0'),
  this.servers = const <Server>[],
  this.securitySchemes = const <String, SecurityScheme>{},
  this.securityByMiddleware =
      const <String, List<Map<String, List<String>>>>{},
  this.registry = const OpenApiRegistry(),
  this.ui = DocsUi.scalar,
  this.scalar = const ScalarOptions(),
  this.pageTitle,
  this.include = const <String>[],
  this.exclude = const <String>[],
});