# OpenApiParamsBuilder Class private
Module | import { OpenApiParamsBuilder } from "@tsed/swagger/src/class/OpenApiParamsBuilder" |
---|---|
Source | /packages/swagger/src/class/OpenApiParamsBuilder.ts |
# Overview
class OpenApiParamsBuilder extends OpenApiModelSchemaBuilder {
<span class="token keyword">constructor</span><span class="token punctuation">(</span>target<span class="token punctuation">:</span> <a href="/api/core/interfaces/Type.html"><span class="token">Type</span></a><<span class="token keyword">any</span>><span class="token punctuation">,</span> methodClassName<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">,</span> pathParameters?<span class="token punctuation">:</span> PathParameter<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
get <span class="token function">parameters</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> Parameter<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
/**
*
* @returns <span class="token punctuation">{</span>this<span class="token punctuation">}</span>
*/
<span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> this<span class="token punctuation">;</span>
/**
*
* @param param
* @returns <span class="token punctuation">{</span><a href="/api/mongoose/decorators/Schema.html"><span class="token">Schema</span></a><span class="token punctuation">}</span>
*/
<span class="token keyword">protected</span> <span class="token function">createSchemaFromBodyParam</span><span class="token punctuation">(</span>param<span class="token punctuation">:</span> <a href="/api/common/mvc/models/ParamMetadata.html"><span class="token">ParamMetadata</span></a><span class="token punctuation">)</span><span class="token punctuation">:</span> <a href="/api/mongoose/decorators/Schema.html"><span class="token">Schema</span></a><span class="token punctuation">;</span>
/**
*
* @param <span class="token punctuation">{</span><a href="/api/common/mvc/models/ParamMetadata.html"><span class="token">ParamMetadata</span></a><span class="token punctuation">}</span> model
* @returns <span class="token punctuation">{</span><a href="/api/mongoose/decorators/Schema.html"><span class="token">Schema</span></a><span class="token punctuation">}</span>
*/
<span class="token keyword">protected</span> <span class="token function">createSchemaFromQueryParam</span><span class="token punctuation">(</span>model<span class="token punctuation">:</span> <a href="/api/common/mvc/models/ParamMetadata.html"><span class="token">ParamMetadata</span></a><span class="token punctuation">)</span><span class="token punctuation">:</span> <a href="/api/mongoose/decorators/Schema.html"><span class="token">Schema</span></a><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
/**
*
* @returns <span class="token punctuation">{</span>HeaderParameter<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">}</span>
*/
/**
*
* @returns <span class="token punctuation">{</span><span class="token keyword">any</span><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">}</span>
*/
/**
*
* @returns <span class="token punctuation">{</span><a href="/api/common/mvc/models/ParamMetadata.html"><span class="token">ParamMetadata</span></a> | undefined<span class="token punctuation">}</span>
*/
/**
*
* @returns <span class="token punctuation">{</span>PathParameter<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">}</span>
*/
/**
*
* @returns <span class="token punctuation">{</span>HeaderParameter<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">}</span>
*/
/**
* Create Properties schema <span class="token keyword">from</span> an expression.
* @param param
*/
}
# Members
get parameters(): Parameter[];
build(): this;
protected createSchemaFromBodyParam(param: ParamMetadata): Schema;
protected createSchemaFromQueryParam(model: ParamMetadata): Schema[];
- Session & cookies
- Passport.js
- TypeORM
- Mongoose
- GraphQL
- Socket.io
- Swagger
- AJV
- Multer
- Serve static files
- Templating
- Throw HTTP Exceptions
- Customize 404
- AWS
- Jest
- Seq
- Controllers
- Providers
- Model
- Converters
- Middlewares
- Pipes
- Interceptors
- Authentication
- Hooks
- Injection scopes
- Custom providers
- Custom endpoint decorator
- Testing