SwaggerService Class

Module	import { SwaggerService } from "@tsed/swagger"
Source	/packages/swagger/src/services/SwaggerService.ts

Overview

class SwaggerService {
<span class="token keyword">constructor</span><span class="token punctuation">(</span>injectorService<span class="token punctuation">:</span> <a href="/api/di/services/InjectorService.html"><span class="token">InjectorService</span></a><span class="token punctuation">,</span> platform<span class="token punctuation">:</span> <a href="/api/common/platform/services/Platform.html"><span class="token">Platform</span></a><span class="token punctuation">,</span> configuration<span class="token punctuation">:</span> <a href="/api/di/decorators/Configuration.html"><span class="token">Configuration</span></a><span class="token punctuation">)</span><span class="token punctuation">;</span>
/**
 *
 * @returns <span class="token punctuation">{</span>Spec<span class="token punctuation">}</span>
 */
<span class="token function">getOpenAPISpec</span><span class="token punctuation">(</span>conf<span class="token punctuation">:</span> <a href="/api/swagger/interfaces/SwaggerSettings.html"><span class="token">SwaggerSettings</span></a><span class="token punctuation">)</span><span class="token punctuation">:</span> Spec<span class="token punctuation">;</span>
/**
 * Return the global api information.
 * @returns <span class="token punctuation">{</span>Info<span class="token punctuation">}</span>
 */
<span class="token function">getDefaultSpec</span><span class="token punctuation">(</span>conf<span class="token punctuation">:</span> Partial&lt;<a href="/api/swagger/interfaces/SwaggerSettings.html"><span class="token">SwaggerSettings</span></a>&gt;<span class="token punctuation">)</span><span class="token punctuation">:</span> Spec<span class="token punctuation">;</span>

/**
 *
 * @param paths
 * @param definitions
 * @param ctrl
 * @param endpointUrl
 * @param getOperationId
 */

/**
 *
 * @param ctrl
 */

/**
 *
 * @param <span class="token punctuation">{</span><a href="/api/swagger/interfaces/SwaggerSettings.html"><span class="token">SwaggerSettings</span></a><span class="token punctuation">}</span> conf
 * @returns <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> =&gt; <span class="token punctuation">(</span><span class="token keyword">any</span> | <span class="token keyword">string</span><span class="token punctuation">)</span><span class="token punctuation">}</span>
 */
}

Members

getOpenAPISpec(conf: SwaggerSettings): Spec;

---

getDefaultSpec(conf: Partial<SwaggerSettings>): Spec;

Return the global api information.