This is a plugin for reading and parsing the request payload.
Table of Contents
npm install @routup/swagger --save
To read the docs, visit https://routup.net
Generate a swagger document for the API endpoints.
V2
import { generate, Version } from '@routup/swager';
import process from 'node:process';
await generate({
version: Version.V2,
options: {
metadata: {
preset: '@routup/swagger-preset',
entryPoint: {
cwd: process.cwd(),
pattern: '**/*.ts',
},
},
output: true,
outputDirectory: 'writable',
servers: ['http://localhost:3000/'],
},
});
The function call will save the file under the location: ./writable/swagger.json
.
V3
import { generate, Version } from '@routup/swager';
import process from 'node:process';
await generate({
version: Version.V3,
options: {
metadata: {
preset: '@routup/swagger-preset',
entryPoint: {
cwd: process.cwd(),
pattern: '**/*.ts',
},
},
output: true,
outputDirectory: 'writable',
servers: ['http://localhost:3000/'],
},
});
The function call will save the file under the location: ./writable/swagger.json
.
Serve generated docs from (file- / web-) URL or based on a JSON file with swagger-ui.
import { createServer } from 'node:http';
import {
createNodeDispatcher,
Router
} from 'routup';
import { swaggerUI } from '@routup/swagger';
const router = new Router();
router.use('/docs', swaggerUI('test/data/swagger.json'));
const server = createServer(createNodeDispatcher(router));
server.listen(3000);
Now open the browser and visit:
http://localhost:3000/docs/
Made with 💚
Published under MIT License.