# OpenApiEndpointBuilder Class private
Module | import { OpenApiEndpointBuilder } from "@tsed/swagger/src/class/OpenApiEndpointBuilder" |
---|---|
Source | /packages/swagger/src/class/OpenApiEndpointBuilder.ts |
# Overview
class OpenApiEndpointBuilder extends OpenApiModelSchemaBuilder {
<span class="token keyword">constructor</span><span class="token punctuation">(</span>endpoint<span class="token punctuation">:</span> <a href="/api/common/mvc/models/EndpointMetadata.html"><span class="token">EndpointMetadata</span></a><span class="token punctuation">,</span> endpointUrl<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">,</span> pathMethod<span class="token punctuation">:</span> <span class="token punctuation">{</span>
path?<span class="token punctuation">:</span> <a href="/api/common/mvc/interfaces/PathParamsType.html"><span class="token">PathParamsType</span></a><span class="token punctuation">;</span>
method?<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span> getOperationId<span class="token punctuation">:</span> <span class="token punctuation">(</span>targetName<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">,</span> methodName<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">)</span> => <span class="token keyword">string</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
/**
*
* @returns <span class="token punctuation">{</span><span class="token punctuation">}</span>
*/
get <span class="token function">paths</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token punctuation">{</span>
<span class="token punctuation">[</span>p<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">]</span><span class="token punctuation">:</span> Path<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 <span class="token punctuation">{</span><a href="/api/swagger/interfaces/OpenApiResponses.html"><span class="token">OpenApiResponses</span></a><span class="token punctuation">}</span> builderResponses
* @returns <span class="token punctuation">{</span><a href="/api/swagger/interfaces/OpenApiResponses.html"><span class="token">OpenApiResponses</span></a><span class="token punctuation">}</span>
*/
/**
*
* @returns <span class="token punctuation">{</span>Operation<span class="token punctuation">}</span>
* @param builder
*/
/**
*
* @returns <span class="token punctuation">{</span><span class="token keyword">string</span><span class="token punctuation">}</span>
*/
/**
*
* @param <span class="token punctuation">{</span><span class="token keyword">string</span> | <span class="token keyword">number</span><span class="token punctuation">}</span> code
* @param options
* @returns <span class="token punctuation">{</span><a href="/api/common/mvc/decorators/params/Response.html"><span class="token">Response</span></a><span class="token punctuation">}</span>
*/
}
# Members
get paths(): {
[p: string]: Path;
};
build(): this;
- 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