https://github.com/m-radzikowski/aws-swaggerui

Serverless Swagger UI for API Gateway
https://github.com/m-radzikowski/aws-swaggerui

api-gateway cognito serverless serverless-framework swagger swagger-ui

Last synced: about 1 month ago
JSON representation

Serverless Swagger UI for API Gateway

• Host: GitHub
• URL: https://github.com/m-radzikowski/aws-swaggerui
• Owner: m-radzikowski
• Created: 2020-10-09T22:12:08.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-11-20T10:22:38.000Z (almost 2 years ago)
• Last Synced: 2024-06-17T22:48:12.598Z (3 months ago)
• Topics: api-gateway, cognito, serverless, serverless-framework, swagger, swagger-ui
• Language: TypeScript
• Homepage: https://betterdev.blog/serverless-swagger-ui-for-api-gateway/
• Size: 237 KB
• Stars: 51
• Watchers: 3
• Forks: 20
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - m-radzikowski/aws-swaggerui - Serverless Swagger UI for API Gateway (TypeScript)

README

        
# Serverless Swagger UI for API Gateway

Example of automatically built and deployed

Swagger UI website with interactive documentation

for the API Gateway, protected with Cognito user authentication.

See the article with full description:

[Serverless Swagger UI for API Gateway](https://betterdev.blog/serverless-swagger-ui-for-api-gateway/)

## Development

Install dependencies:

```bash

yarn install

```

Change the `project` and/or `service` name

in [serverless.yml](./serverless.yml) file

to have unique `baseName`, that is used as a Cognito auth domain.

Deploy:

```bash

yarn run deploy --region REGION

```

In AWS Console, go to Cognito → Manage User Pools → newly created User Pool →

Users and groups, and create user.

Go to CloudFront, find created Distribution, copy the Domain Name

and open in a browser. Login with user credentials created in Cognito.

You will be redirected to the Swagger UI.

Run Swagger UI locally (for Swagger UI website development):

```bash

yarn run start

```

It will start the development server at http://localhost:8080.

It uses the same deployed AWS resources. To log in,

use the same user created in the Cognito.

Remove deployed stack to clean resources:

```bash

yarn run remove --region REGION

```