技术标签: 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
然后会弹出导出导入预览,第一次导入默认就可以了,然后点确认导入
完后会弹出一个导入成功的按钮
最后点在接口管理,就可以看到你导入的接口了
这样我们就完成了导入
文章浏览阅读1.6k次。安装配置gi、安装数据库软件、dbca建库见下:http://blog.csdn.net/kadwf123/article/details/784299611、检查集群节点及状态:[root@rac2 ~]# olsnodes -srac1 Activerac2 Activerac3 Activerac4 Active[root@rac2 ~]_12c查看crs状态
文章浏览阅读1.3w次,点赞45次,收藏99次。我个人用的是anaconda3的一个python集成环境,自带jupyter notebook,但在我打开jupyter notebook界面后,却找不到对应的虚拟环境,原来是jupyter notebook只是通用于下载anaconda时自带的环境,其他环境要想使用必须手动下载一些库:1.首先进入到自己创建的虚拟环境(pytorch是虚拟环境的名字)activate pytorch2.在该环境下下载这个库conda install ipykernelconda install nb__jupyter没有pytorch环境
文章浏览阅读5.2k次,点赞19次,收藏28次。选择scoop纯属意外,也是无奈,因为电脑用户被锁了管理员权限,所有exe安装程序都无法安装,只可以用绿色软件,最后被我发现scoop,省去了到处下载XXX绿色版的烦恼,当然scoop里需要管理员权限的软件也跟我无缘了(譬如everything)。推荐添加dorado这个bucket镜像,里面很多中文软件,但是部分国外的软件下载地址在github,可能无法下载。以上两个是官方bucket的国内镜像,所有软件建议优先从这里下载。上面可以看到很多bucket以及软件数。如果官网登陆不了可以试一下以下方式。_scoop-cn
文章浏览阅读4.5k次,点赞2次,收藏3次。首先要有一个color-picker组件 <el-color-picker v-model="headcolor"></el-color-picker>在data里面data() { return {headcolor: ’ #278add ’ //这里可以选择一个默认的颜色} }然后在你想要改变颜色的地方用v-bind绑定就好了,例如:这里的:sty..._vue el-color-picker
文章浏览阅读640次。基于芯片日益增长的问题,所以内核开发者们引入了新的方法,就是在内核中只保留函数,而数据则不包含,由用户(应用程序员)自己把数据按照规定的格式编写,并放在约定的地方,为了不占用过多的内存,还要求数据以根精简的方式编写。boot启动时,传参给内核,告诉内核设备树文件和kernel的位置,内核启动时根据地址去找到设备树文件,再利用专用的编译器去反编译dtb文件,将dtb还原成数据结构,以供驱动的函数去调用。firmware是三星的一个固件的设备信息,因为找不到固件,所以内核启动不成功。_exynos 4412 刷机
文章浏览阅读2w次,点赞24次,收藏42次。Linux系统配置jdkLinux学习教程,Linux入门教程(超详细)_linux配置jdk
文章浏览阅读3.3k次,点赞5次,收藏19次。xlabel('\delta');ylabel('AUC');具体符号的对照表参照下图:_matlab微米怎么输入
文章浏览阅读119次。顺序读写指的是按照文件中数据的顺序进行读取或写入。对于文本文件,可以使用fgets、fputs、fscanf、fprintf等函数进行顺序读写。在C语言中,对文件的操作通常涉及文件的打开、读写以及关闭。文件的打开使用fopen函数,而关闭则使用fclose函数。在C语言中,可以使用fread和fwrite函数进行二进制读写。 Biaoge 于2024-03-09 23:51发布 阅读量:7 ️文章类型:【 C语言程序设计 】在C语言中,用于打开文件的函数是____,用于关闭文件的函数是____。
文章浏览阅读3.4k次,点赞2次,收藏13次。跟随鼠标移动的粒子以grid(SOP)为partical(SOP)的资源模板,调整后连接【Geo组合+point spirit(MAT)】,在连接【feedback组合】适当调整。影响粒子动态的节点【metaball(SOP)+force(SOP)】添加mouse in(CHOP)鼠标位置到metaball的坐标,实现鼠标影响。..._touchdesigner怎么让一个模型跟着鼠标移动
文章浏览阅读178次。项目运行环境配置:Jdk1.8 + Tomcat7.0 + Mysql + HBuilderX(Webstorm也行)+ Eclispe(IntelliJ IDEA,Eclispe,MyEclispe,Sts都支持)。项目技术:Springboot + mybatis + Maven +mysql5.7或8.0+html+css+js等等组成,B/S模式 + Maven管理等等。环境需要1.运行环境:最好是java jdk 1.8,我们在这个平台上运行的。其他版本理论上也可以。_基于java技术的停车场管理系统实现与设计
文章浏览阅读3.5k次。前言对于MediaPlayer播放器的源码分析内容相对来说比较多,会从Java-&amp;gt;Jni-&amp;gt;C/C++慢慢分析,后面会慢慢更新。另外,博客只作为自己学习记录的一种方式,对于其他的不过多的评论。MediaPlayerDemopublic class MainActivity extends AppCompatActivity implements SurfaceHolder.Cal..._android多媒体播放源码分析 时序图
文章浏览阅读2.4k次,点赞41次,收藏13次。java 数据结构与算法 ——快速排序法_快速排序法