本文整理汇总了TypeScript中@nestjs/swagger.SwaggerModule.createDocument方法的典型用法代码示例。如果您正苦于以下问题：TypeScript SwaggerModule.createDocument方法的具体用法？TypeScript SwaggerModule.createDocument怎么用？TypeScript SwaggerModule.createDocument使用的例子？那么恭喜您, 这里精选的方法代码示例或许可以为您提供帮助。您也可以进一步了解该方法所在类@nestjs/swagger.SwaggerModule的用法示例。
在下文中一共展示了SwaggerModule.createDocument方法的8个代码示例，这些例子默认根据受欢迎程度排序。您可以为喜欢或者感觉有用的代码点赞，您的评价将有助于系统推荐出更棒的TypeScript代码示例。
示例1: bootstrap
async function bootstrap() {
//創建express 實例
const instance = express();
//middleware
instance.use(bodyParser.json());
instance.use(bodyParser.urlencoded({ extended: false }));
//NestFactory.create()接受一個模組引數，和一個可選的express實例引數，並返回Promise。
const app = await NestFactory.create(ApplicationModule, instance);
//swagger options
const options = new DocumentBuilder()
.setTitle('Users Restful API')
.setDescription('The users Restful API description')
.setVersion('1.0')
.addTag('users')
.build();
//restful API 文檔
const document = SwaggerModule.createDocument(app, options);
//打開http://localhost/api 就會連結到swagger服務。
SwaggerModule.setup('/api', app, document);
await app.listen(3000)
}示例2: bootstrap
async function bootstrap(): Promise<void> {
const app = await NestFactory.create(M1cr0blogModule, { cors: true })
// Set up static content rendering
app.useStaticAssets(__dirname + '/static')
app.setBaseViewsDir(__dirname + '/views')
app.setViewEngine('hbs')
hbs.registerPartials(__dirname + '/views/partials')
hbs.registerHelper('unlessEquals', function(arg1, arg2, options) {
//@ts-ignore
return (arg1 != arg2) ? options.fn(this) : options.inverse(this);
})
hbs.registerHelper('replace', function(needle: string, newstr: string, options) {
//@ts-ignore
return options.fn(this).replace(needle, newstr)
})
// Set up Swagger
const options = new DocumentBuilder()
.setTitle('M1cr0blog API')
.setDescription('Backend REST API for m1cr0man\'s blog')
.setVersion('1.0')
.addTag('Users', 'User management system')
.addBearerAuth()
.build()
const document = SwaggerModule.createDocument(app, options)
SwaggerModule.setup('api/swagger', app, document)
await app.listen(3000)
}示例3: bootstrap
async function bootstrap() {
const app = await NestFactory.create(AppModule);
const options = new DocumentBuilder()
.setTitle("Blog API")
.setDescription("Back office, for a blog API")
.setVersion("1.0")
.build();
const document = SwaggerModule.createDocument(app, options);
SwaggerModule.setup("docs", app, document);
await app.listen(configService.getNumber("PORT"));
}示例4: bootstrap
async function bootstrap() {
const app = await NestFactory.create(ApplicationModule,);
app.use(bodyParser.json());
app.useGlobalPipes(new ValidationPipe());
/**
* Headers setup
*/
app.use((req, res, next) => {
res.header('Access-Control-Allow-Origin', '*');
res.header('Access-Control-Allow-Headers', 'Origin, X-Requested-With, Content-Type, Accept, Authorization');
next();
});
/**
* Swagger implementation
*/
const options = new DocumentBuilder()
.setTitle('Chainservice API')
.setDescription('The Chainservice API')
.setVersion('1.0')
.setExternalDoc('Github repo', 'https://github.com/wearetheledger/hyperledger-typescript-boilerplate')
.addOAuth2('implicit', `https://${EnvConfig.AUTH0_DOMAIN}/authorize`, `https://${EnvConfig.AUTH0_DOMAIN}/oauth/token`)
.build();
const document = SwaggerModule.createDocument(app, options);
SwaggerModule.setup('/api', app, document, {
swaggerOptions: {
oauth2RedirectUrl: `${EnvConfig.DOMAIN_URL}/api/oauth2-redirect.html`,
oauth: {
clientId: EnvConfig.AUTH0_CLIENT_ID,
appName: 'Chainservice API',
scopeSeparator: ' ',
additionalQueryStringParams: {audience: EnvConfig.AUTH0_AUDIENCE}
}
}
});
/**
* Start Chainservice API
*/
await app.listen(+EnvConfig.PORT, () => {
Log.config.info(`Started Chain-service on PORT ${EnvConfig.PORT}`);
});
}示例5: bootstrap
async function bootstrap() {
const app = await NestFactory.create(ApplicationModule);
const options = new DocumentBuilder()
.setTitle('Cats example')
.setDescription('The cats API description')
.setVersion('1.0')
.addTag('cats')
.addBearerAuth()
.build();
const document = SwaggerModule.createDocument(app, options);
SwaggerModule.setup('api', app, document);
await app.listen(3001);
}示例6: bootstrap
async function bootstrap() {
const app = await NestFactory.create(AppModule, {
// logger: new MyLogger(),
});
app.enableCors();
const options = new DocumentBuilder()
.setTitle('Cats example')
.setDescription('The cats API description')
.setVersion('1.0')
.addTag('cats')
.addBearerAuth()
.build();
const document = SwaggerModule.createDocument(app, options);
SwaggerModule.setup('api', app, document);
app.useWebSocketAdapter(new WsAdapter(app.getHttpServer()));
await app.listen(3081);
}示例7: bootstrap
async function bootstrap() {
const app = await NestFactory.create(AppModule);
app.useGlobalPipes(new ValidationPipe({ transform: true }));
const options = new DocumentBuilder()
.setTitle('Saevis')
.setDescription('')
.setVersion('1.0')
.addBearerAuth()
.build();
const document = SwaggerModule.createDocument(app, options);
SwaggerModule.setup('api', app, document);
app.use('/swagger.json', (req, res, next) => res.send(document));
app.enableCors();
await app.listen(3000);
if (module.hot) {
module.hot.accept();
module.hot.dispose(() => app.close());
}
}示例8: startApp
export async function startApp(): Promise<http.Server> {
const app = express();
app.use(express.static(__dirname + '/static'));
const nestApp = await NestFactory.create(AppModule, app);
const options = new DocumentBuilder()
.setTitle('Notes API')
.setDescription('Use this API to work with notes.')
.setVersion('1.0')
.build();
const document = SwaggerModule.createDocument(nestApp, options);
SwaggerModule.setup('/docs', nestApp, document);
nestApp.useGlobalPipes(new MyValidationPipe());
nestApp.useGlobalFilters(new MyHttpExceptionFilter());
const port = 3000;
const server = await nestApp.listen(port, () => {
console.log(`Listening at port ${port}`);
});
return server;
}