https://github.com/nightapes/serverless-openapi

Generate openapi file from your serverless file
https://github.com/nightapes/serverless-openapi

openapi serverless swagger

Last synced: 3 months ago
JSON representation

Generate openapi file from your serverless file

• Host: GitHub
• URL: https://github.com/nightapes/serverless-openapi
• Owner: Nightapes
• License: mit
• Created: 2022-01-29T12:09:32.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-19T09:32:52.000Z (over 1 year ago)
• Last Synced: 2024-04-29T18:23:39.815Z (8 months ago)
• Topics: openapi, serverless, swagger
• Language: TypeScript
• Homepage: https://nightapes.github.io/serverless-openapi/
• Size: 620 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# serverless-openapi

A simple openapi generator for [serverless](serverless.com).

Support for serverless 2 and 3

The files is generated locally without any upload to aws apigateway.

## Install

`npm i -D @nightapes/serverless-openapi`

## Usage

Add plugin into your `serverless.yml` file

```yml

plugins:

  - '@nightapes/serverless-openapi'

```

## Documentation

A detailed documentation can be found [here](/packages/serverless-openapi/README.md)