openapi-ts-redoc
This library is an extension for @kojidev/openapi-ts
. It adds OpenAPI extensions and types used by ReDoc, please read ReDoc vendor extensions reference first.
Installation
This package is available in npm Registry:
npm install @flaksp/openapi-ts-redoc --save
Usage examples
This example shows how to extend OpenAPI
and how to use ReDoc's type TagGroup
:
import { OpenAPI, Tag, openapiVersion } from '@kojidev/openapi-ts';
import { OpenAPIReDocExtension, TagGroup } from '@flaksp/openapi-ts-redoc';
const cartTag: Tag = {
name: 'Cart',
};
const shippingTag: Tag = {
name: 'Shipping',
};
const storeTagGroup: TagGroup = {
name: 'Store',
tags: [
cartTag.name,
shippingTag.name,
],
};
export const openapi: OpenAPI & OpenAPIReDocExtension = {
info: {
title: 'Example',
version: '1.0.0',
},
openapi: openapiVersion,
paths: {},
tags: [
cardTag,
shippingTag,
],
'x-tagGroups': [
storeTagGroup,
],
};