List of Contents

Usage

NestJS

import{DocumentBuilder,SwaggerModule}from"@nestjs/swagger";import{openApiUIReference}from"@openapi-ui/nestjs-openapi-ui";constapp=awaitNestFactory.create(AppModule);constconfig=newDocumentBuilder().setTitle('Cats example').setDescription('The cats API description').setVersion('1.0').addTag('cats').build()constdocument=SwaggerModule.createDocument(app,config);SwaggerModule.setup("swagger",app,document,{jsonDocumentUrl:"/openapi.json",});app.use("/openapi",openApiUIReference({specPath:"/openapi.json",}),);

Express

import{openApiUIReference}from'@openapi-ui/express-openapi-ui';importswaggerJsdocfrom"swagger-jsdoc";constopenApiSpec=swaggerJsdoc({definition:{openapi:"3.0.0",info:{title:"Hello World",version:"1.0",},},apis:["./src/*.ts"],// files containing annotations as above});app.get('/openapi.json',(req,res)=>{res.json(openApiSpec);});app.use('/openapi',openApiUIReference({specPath:'/openapi.json',}),);

Hono

import{openApiUIReference}from'@openapi-ui/hono-openapi-ui';app.doc('/openapi.json',{info:{title:'Example API',description:'Example API description',version:'1.0.0',},openapi:'3.0.0',});app.use('/openapi',openApiUIReference({specPath:'/openapi.json',}),);

License