@tsed/openspec

OpenSpec2 and OpenSpec3 interfaces declarations for TypeScript application

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@tsed/openspec
2,248416.133.08 days ago2 years agoMinified + gzip package size for @tsed/openspec in KB

Readme

Ts.ED logo


<h1>@tsed/openspec</h1>
Build & Release PR Welcome Coverage Status npm version semantic-release code style: prettier github opencollective

Website   •   Getting started   •   Slack   •   Twitter



A package of Ts.ED framework. See website: https://tsed.io/

OpenSpec2 and OpenSpec3 interfaces declarations for TypeScript application.

Documentation

Documentation is available on https://tsed.io

Installation

You can get the latest release and the type definitions using npm:
npm install --save @tsed/openspec

Usage

import {OpenSpec3, OpenSpec2} from "@tsed/openspec";

const spec3: OpenSpec3 = {openapi: "3.0.1", paths: {}};
const spec2: OpenSpec2 = {swagger: "2.0", paths: {}};

Contributors

Please read contributing guidelines here

Backers

Thank you to all our backers! 🙏 Become a backer

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor

License

The MIT License (MIT)
Copyright (c) 2016 - 2022 Romain Lenzotti
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.