技术标签: apifox nestjs javascript/typescript/node javascript/typescript javascript swagger
$ npm install --save @nestjs/swagger
import {
NestFactory } from '@nestjs/core';
import {
SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import {
AppModule } from './app.module';
async function bootstrap() {
const app = await NestFactory.create(AppModule);
const config = new DocumentBuilder()
.setTitle('Cats example')
.setDescription('The cats API description')
.setVersion('1.0')
.addTag('cats')
.build();
const document = SwaggerModule.createDocument(app, config);
SwaggerModule.setup('api', app, document);
await app.listen(3000);
}
bootstrap();
import './init/init';
import {
NestFactory } from '@nestjs/core';
import {
AppModule } from './app.module';
import {
getLogger } from 'xmcommon';
import {
NestLogger } from './common/nest.logger';
import {
RequestInterceptor } from './common/request.interceptor';
import {
HttpFilterFilter } from './common/http_filter.filter';
import {
NestExpressApplication } from '@nestjs/platform-express';
import session from 'express-session';
import path from 'path';
import {
AuthGuard } from './common/auth.guard';
import {
EnvUtils } from './env_utils';
import {
ConfigUtils } from './init/config_utils';
import {
ValidationPipe } from './common/validation_pipe';
const log = getLogger(__filename);
log.info('程序开始启动... 当前环境:' + EnvUtils.env + ' 开发环境:' + EnvUtils.isDev);
async function bootstrap() {
const globalConfig = ConfigUtils.getConfig();
const app = await NestFactory.create<NestExpressApplication>(AppModule, {
logger: new NestLogger(),
});
app.use(session(ConfigUtils.buildSessionOptions()));
// app.useStaticAssets(path.join(process.cwd(), 'public'), { prefix: '/static/' });
app.useStaticAssets(path.join(process.cwd(), 'public'), {
});
app.setBaseViewsDir(path.join(process.cwd(), 'view')); // 放视图的文件
app.setViewEngine('ejs');
app.useGlobalPipes(new ValidationPipe());
app.useGlobalInterceptors(new RequestInterceptor());
app.useGlobalFilters(new HttpFilterFilter());
app.useGlobalGuards(new AuthGuard());
if (EnvUtils.isDev) {
// 如果是开发模式,则加载文档
// eslint-disable-next-line @typescript-eslint/no-var-requires
const {
DocumentBuilder, SwaggerModule } = require('@nestjs/swagger');
const config = new DocumentBuilder()
.setTitle('Cats example')
.setDescription('The cats API description')
.setVersion('1.0')
.addTag('cats')
.build();
const document = SwaggerModule.createDocument(app, config);
SwaggerModule.setup('apidoc', app, document);
log.info(`swagger url: http://localhost:4000/apidoc`);
}
await app.listen(4000);
log.info(`开始侦听:4000...`);
}
bootstrap();
import {
Controller, Get } from '@nestjs/common';
import {
ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
import {
AppService } from './app.service';
@ApiTags('应用系列接口')
@Controller()
export class AppController {
constructor(private readonly appService: AppService) {
}
@Get()
@ApiOperation({
summary: '返回hello' })
@ApiResponse({
type: String })
getHello(): string {
return this.appService.getHello();
}
}
$ run run start
@ApiTags('登录相关接口')
@Controller('login')
export class CLoginController {
}
@ApiProperty({
title: '手机号', maxLength: 11, minLength: 11 })
@ApiBearerAuth('JWT')
apifox的请求参数
auth类型列表
@ApiOperation({
summary: '使用验证码登录', description: '要求先获得验证码' })
// 登录返回的VO
@ApiTags('登录返回的VO')
export class XDoLoginVO extends XRetVO {
@ApiProperty({
title: '具体返回的数据 ' })
data?: XTokenInfo;
}
// 使用验证码登录的请求参数
@ApiTags('使用验证码登录的请求参数')
export class XDTODoLogin {
@ApiProperty({
title: '手机号', maxLength: 11, minLength: 11 })
mobile: string;
@ApiProperty({
title: '验证码', maxLength: 8, minLength: 1 })
code: string;
}
// 登录请求
@Post('login')
@ApiOperation({
summary: '使用验证码登录', description: '要求先获得验证码' })
@ApiOkResponse({
type: XDoLoginVO })
private async doLogin(@Body() paramBody: XDTODoLogin) {
const r = new XCommonRet();
do {
const result = (await this.user.adminLogin(
paramBody.mobile,
paramBody.code,
)) as XCommonRet<ITokenString>;
r.assignFrom(result);
} while (false);
return r;
}
@ApiOkResponse()
@ApiCreatedResponse()
@ApiAcceptedResponse()
@ApiNoContentResponse()
@ApiMovedPermanentlyResponse()
@ApiFoundResponse()
@ApiBadRequestResponse()
@ApiUnauthorizedResponse()
@ApiNotFoundResponse()
@ApiForbiddenResponse()
@ApiMethodNotAllowedResponse()
@ApiNotAcceptableResponse()
@ApiRequestTimeoutResponse()
@ApiConflictResponse()
@ApiPreconditionFailedResponse()
@ApiTooManyRequestsResponse()
@ApiGoneResponse()
@ApiPayloadTooLargeResponse()
@ApiUnsupportedMediaTypeResponse()
@ApiUnprocessableEntityResponse()
@ApiInternalServerErrorResponse()
@ApiNotImplementedResponse()
@ApiBadGatewayResponse()
@ApiServiceUnavailableResponse()
@ApiGatewayTimeoutResponse()
@ApiDefaultResponse()
每次都用apifox更新接口文档是一个很痛苦的事情,还好有可以导入
apifox可以支持很多种导入,这里只针对nestjs集成的swagger
用apifox创建一个项目后,再点导入
显示导入选择框,可以看到apifox集居了很多种格式的导入, 这里选择OpenAPI/Swagger和URL导入
选择URL试,输入URL http://localhost:3000/api-json
然后会弹出导出导入预览,第一次导入默认就可以了,然后点确认导入
完后会弹出一个导入成功的按钮
最后点在接口管理,就可以看到你导入的接口了
这样我们就完成了导入
文章浏览阅读645次。这个肯定是末尾的IDAT了,因为IDAT必须要满了才会开始一下个IDAT,这个明显就是末尾的IDAT了。,对应下面的create_head()代码。,对应下面的create_tail()代码。不要考虑爆破,我已经试了一下,太多情况了。题目来源:UNCTF。_攻防世界困难模式攻略图文
文章浏览阅读2.9k次,点赞3次,收藏10次。偶尔会用到,记录、分享。1. 数据库导出1.1 切换到dmdba用户su - dmdba1.2 进入达梦数据库安装路径的bin目录,执行导库操作 导出语句:./dexp cwy_init/[email protected]:5236 file=cwy_init.dmp log=cwy_init_exp.log 注释: cwy_init/init_123..._达梦数据库导入导出
文章浏览阅读1.9k次。1. 在官网上下载KindEditor文件,可以删掉不需要要到的jsp,asp,asp.net和php文件夹。接着把文件夹放到项目文件目录下。2. 修改html文件,在页面引入js文件:<script type="text/javascript" src="./kindeditor/kindeditor-all.js"></script><script type="text/javascript" src="./kindeditor/lang/zh-CN.js"_kindeditor.js
文章浏览阅读2.3k次,点赞6次,收藏14次。SPI的详情简介不必赘述。假设我们通过SPI发送0xAA,我们的数据线就会变为10101010,通过修改不同的内容,即可修改SPI中0和1的持续时间。比如0xF0即为前半周期为高电平,后半周期为低电平的状态。在SPI的通信模式中,CPHA配置会影响该实验,下图展示了不同采样位置的SPI时序图[1]。CPOL = 0,CPHA = 1:CLK空闲状态 = 低电平,数据在下降沿采样,并在上升沿移出CPOL = 0,CPHA = 0:CLK空闲状态 = 低电平,数据在上升沿采样,并在下降沿移出。_stm32g431cbu6
文章浏览阅读1.2k次,点赞2次,收藏8次。数据链路层习题自测问题1.数据链路(即逻辑链路)与链路(即物理链路)有何区别?“电路接通了”与”数据链路接通了”的区别何在?2.数据链路层中的链路控制包括哪些功能?试讨论数据链路层做成可靠的链路层有哪些优点和缺点。3.网络适配器的作用是什么?网络适配器工作在哪一层?4.数据链路层的三个基本问题(帧定界、透明传输和差错检测)为什么都必须加以解决?5.如果在数据链路层不进行帧定界,会发生什么问题?6.PPP协议的主要特点是什么?为什么PPP不使用帧的编号?PPP适用于什么情况?为什么PPP协议不_接收方收到链路层数据后,使用crc检验后,余数为0,说明链路层的传输时可靠传输
文章浏览阅读587次。软件测试工程师移民加拿大 无证移民,未受过软件工程师的教育(第1部分) (Undocumented Immigrant With No Education to Software Engineer(Part 1))Before I start, I want you to please bear with me on the way I write, I have very little gen...
文章浏览阅读304次。Thinkpad X250笔记本电脑,装的是FreeBSD,进入BIOS修改虚拟化配置(其后可能是误设置了安全开机),保存退出后系统无法启动,显示:secure boot failed ,把自己惊出一身冷汗,因为这台笔记本刚好还没开始做备份.....根据错误提示,到bios里面去找相关配置,在Security里面找到了Secure Boot选项,发现果然被设置为Enabled,将其修改为Disabled ,再开机,终于正常启动了。_安装完系统提示secureboot failure
文章浏览阅读10w+次,点赞93次,收藏352次。1、用strtok函数进行字符串分割原型: char *strtok(char *str, const char *delim);功能:分解字符串为一组字符串。参数说明:str为要分解的字符串,delim为分隔符字符串。返回值:从str开头开始的一个个被分割的串。当没有被分割的串时则返回NULL。其它:strtok函数线程不安全,可以使用strtok_r替代。示例://借助strtok实现split#include <string.h>#include <stdio.h&_c++ 字符串分割
文章浏览阅读2.3k次。1 .高斯日记 大数学家高斯有个好习惯:无论如何都要记日记。他的日记有个与众不同的地方,他从不注明年月日,而是用一个整数代替,比如:4210后来人们知道,那个整数就是日期,它表示那一天是高斯出生后的第几天。这或许也是个好习惯,它时时刻刻提醒着主人:日子又过去一天,还有多少时光可以用于浪费呢?高斯出生于:1777年4月30日。在高斯发现的一个重要定理的日记_2013年第四届c a组蓝桥杯省赛真题解答
文章浏览阅读851次,点赞17次,收藏22次。摘要:本文利用供需算法对核极限学习机(KELM)进行优化,并用于分类。
文章浏览阅读1.1k次。一、系统弱密码登录1、在kali上执行命令行telnet 192.168.26.1292、Login和password都输入msfadmin3、登录成功,进入系统4、测试如下:二、MySQL弱密码登录:1、在kali上执行mysql –h 192.168.26.129 –u root2、登录成功,进入MySQL系统3、测试效果:三、PostgreSQL弱密码登录1、在Kali上执行psql -h 192.168.26.129 –U post..._metasploitable2怎么进入
文章浏览阅读257次。本文将为初学者提供Python学习的详细指南,从Python的历史、基础语法和数据类型到面向对象编程、模块和库的使用。通过本文,您将能够掌握Python编程的核心概念,为今后的编程学习和实践打下坚实基础。_python人工智能开发从入门到精通pdf