https://github.com/niradler/micro-swagger

Import swagger files from aws api gateway, and create a swagger ui for them.
https://github.com/niradler/micro-swagger

api-gateway aws openapi swagger

Last synced: 25 days ago
JSON representation

Import swagger files from aws api gateway, and create a swagger ui for them.

• Host: GitHub
• URL: https://github.com/niradler/micro-swagger
• Owner: niradler
• Created: 2019-02-08T11:02:35.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-10-21T07:19:06.000Z (about 3 years ago)
• Last Synced: 2024-11-30T15:42:28.144Z (about 1 month ago)
• Topics: api-gateway, aws, openapi, swagger
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/micro-swagger
• Size: 258 KB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# micro-swagger

Import swagger files from aws api gateway, and create a swagger ui for them.

## Usage

```

npm i -g micro-swagger

```

```

Usage: micro-swagger [options] [command]

Options:

  -V, --version    output the version number

  --region         aws region

  --profile        aws profile

  -h, --help       output usage information

Commands:

  start [options]  Start micro-swagger server.

```

```

micro-swagger start -p 3055

```

- visit http://localhost:3055

### AWS credentials

if you have aws cli configure on your machine you dont need to worry about that,

if not you can setup the credentials using one of this two options:

- Loaded from the shared credentials file (~/.aws/credentials)

- Loaded from environment variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)