Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tada5hi/trapi

TRAPI is a collection of packages to create/generate metadata for REST-APis and generate swagger documentations.
https://github.com/tada5hi/trapi

api decorators http openapi openapi3 rest rest-api swagger typescript

Last synced: 20 days ago
JSON representation

TRAPI is a collection of packages to create/generate metadata for REST-APis and generate swagger documentations.

Host: GitHub
URL: https://github.com/tada5hi/trapi
Owner: tada5hi
License: mit
Created: 2022-08-20T13:17:32.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2024-10-18T19:05:56.000Z (28 days ago)
Last Synced: 2024-10-19T13:29:21.761Z (28 days ago)
Topics: api, decorators, http, openapi, openapi3, rest, rest-api, swagger, typescript
Language: TypeScript
Homepage: https://trapi.tada5hi.net
Size: 10.4 MB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 12
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

README

        # TRAPI 🦜

[![main](https://github.com/Tada5hi/trapi/actions/workflows/main.yml/badge.svg)](https://github.com/Tada5hi/trapi/actions/workflows/main.yml)

[![codecov](https://codecov.io/gh/Tada5hi/trapi/branch/main/graph/badge.svg?token=ZUJ8F5TTSX)](https://codecov.io/gh/Tada5hi/trapi)

[![Known Vulnerabilities](https://snyk.io/test/github/Tada5hi/trapi/badge.svg)](https://snyk.io/test/github/Tada5hi/trapi)

## What is it?

**T**ypeScript **R**est **API** is a collection of packages to create/generate:

- Metadata for REST-APIs

- Swagger documentation

**Table of Contents**

- [Packages](#packages)

- [Documentation](#documentation)

- [License](#license)

## Packages

The repository contains the following packages:

- **@trapi/metadata**: A package for generating metadata information by analyzing present decorators.

  The metadata can than be used for generating a documentation according to the OpenAPI Specification or to create route schema/handling for libraries like: express, koa, etc.

- **@trapi/swagger**: A package to generate a fully featured documentation according the OpenAPI Specification from given metadata.

## Documentation

To read the docs, visit [https://trapi.tada5hi.net](https://trapi.tada5hi.net)

## License

Made with 💚

Published under [MIT License](./LICENSE).