MCPcopy
hub / github.com/nestjs/swagger

github.com/nestjs/swagger @11.4.5 sqlite

repository ↗ · DeepWiki ↗ · release 11.4.5 ↗
1,086 symbols 2,087 edges 229 files 15 documented · 1%
README

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Discord Backers on Open Collective Sponsors on Open Collective

Description

OpenAPI (Swagger) module for Nest.

Installation

$ npm i --save @nestjs/swagger

Quick Start

Overview & Tutorial

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest is MIT licensed.

Extension points exported contracts — how you extend this code

PluginOptions (Interface)
(no doc)
lib/plugin/merge-options.ts
ParamMetadata (Interface)
(no doc)
lib/services/parameter-metadata-accessor.ts
DenormalizedDocResolvers (Interface)
(no doc)
lib/interfaces/denormalized-doc-resolvers.interface.ts
ApiBodyMetadata (Interface)
(no doc)
lib/decorators/api-body.decorator.ts
ParamWithTypeMetadata (Interface)
(no doc)
lib/services/parameter-metadata-accessor.ts
CallBackObject (Interface)
(no doc)
lib/interfaces/callback-object.interface.ts
ApiBodySchemaHost (Interface)
(no doc)
lib/decorators/api-body.decorator.ts
SchemaObjectCommonMetadata (Interface)
(no doc)
lib/interfaces/schema-object-metadata.interface.ts

Core symbols most depended-on inside this repo

ApiProperty
called by 135
lib/decorators/api-property.decorator.ts
ApiProperty
called by 67
lib/extra/swagger-shim.ts
exploreController
called by 63
lib/swagger-explorer.ts
build
called by 61
lib/document-builder.ts
exploreModelSchema
called by 60
lib/services/schema-object-factory.ts
createDocument
called by 55
lib/swagger-module.ts
createPropertyAssignment
called by 47
test/plugin/helpers/metadata-printer.ts
setup
called by 34
lib/swagger-module.ts

Shape

Class 395
Method 321
Function 303
Interface 52
Enum 15

Languages

TypeScript100%

Modules by API surface

test/services/schema-object-factory.spec.ts106 symbols
test/explorer/swagger-explorer.spec.ts96 symbols
lib/extra/swagger-shim.ts93 symbols
test/type-helpers/partial-type-inheritance.spec.ts35 symbols
lib/plugin/utils/ast-utils.ts31 symbols
lib/plugin/visitors/model-class.visitor.ts28 symbols
lib/interfaces/open-api-spec.interface.ts28 symbols
lib/services/schema-object-factory.ts27 symbols
lib/plugin/utils/plugin-utils.ts24 symbols
lib/document-builder.ts24 symbols
e2e/src/cats/cats.controller.ts21 symbols
test/decorators/api-use-tags.decorator.spec.ts20 symbols

Dependencies from manifests, versioned

@commitlint/cli21.1.0 · 1×
@commitlint/config-angular21.1.0 · 1×
@fastify/compress9.0.0 · 1×
@fastify/static9.1.3 · 1×
@microsoft/tsdoc0.16.0 · 1×
@nestjs/common11.1.27 · 1×
@nestjs/core11.1.27 · 1×
@nestjs/mapped-types2.1.1 · 1×
@nestjs/platform-express11.1.27 · 1×
@nestjs/platform-fastify11.1.27 · 1×
@types/js-yaml4.0.9 · 1×
@types/lodash4.17.24 · 1×

For agents

$ claude mcp add swagger \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact