https://github.com/serverless/serverless-swagger-plugin
https://github.com/serverless/serverless-swagger-plugin
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/serverless/serverless-swagger-plugin
- Owner: serverless
- Created: 2016-02-19T08:38:18.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-10-02T07:37:24.000Z (over 8 years ago)
- Last Synced: 2025-04-18T07:51:33.096Z (about 2 months ago)
- Language: JavaScript
- Size: 1.95 KB
- Stars: 44
- Watchers: 8
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Serverless Swagger Import Plugin
**Work in progress. Not ready for use yet.**
This [Serverless](http://serverless.com) plugin imports AWS API Gateway Endpoint configuration (`x-amazon-apigateway-integration` extensions) from a [Swagger](http://swagger.io/) file to `s-function.json`.
## Installation
In your project root, run:
```bash
npm install --save serverless-swagger-import-plugin
```
Add the plugin to `s-project.json`:
```json
"plugins": [
"serverless-swagger-import-plugin"
]
```
## Usage
In a component root folder, run:
```bash
serverless swagger import
```
By default the command will try load the swagger file (`swagger.yaml` or `swagger.json`) from the component folder. You can also specify a path to a swagger file:
```bash
serverless swagger import path/to/swagger.yaml
```