Add SwaggerUI to your AWS Apigateway RestApi
Project description
CDK Apigateway SwaggerUI
Add SwaggerUI to your AWS Apigateway RestApi
Install
TypeScript
npm install @pepperize/cdk-apigateway-swagger-ui
or
yarn add @pepperize/cdk-apigateway-swagger-ui
Python
pip install pepperize.cdk-apigateway-swagger-ui
C# / .Net
dotnet add package Pepperize.CDK.ApigatewaySwaggerUi
Java
<dependency>
<groupId>com.pepperize</groupId>
<artifactId>cdk-apigateway-swagger-ui</artifactId>
<version>${cdkApigatewaySwaggerUi.version}</version>
</dependency>
Usage
import { Stack } from "aws-cdk-lib";
import * as apigateway from "aws-cdk-lib/aws-apigateway";
import { SwaggerUi } from "@pepperize/cdk-apigateway-swagger-ui";
const stack = new Stack();
const restApi = new apigateway.RestApi();
new SwaggerUi(stack, "SwaggerUI", { resource: restApi.root });
- Open your SwaggerUI:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs/swagger-ui.html
- View your API docs:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs.json
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for pepperize.cdk-apigateway-swagger-ui-0.0.167.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a20986db13ed43ccd395c4c539f8aaf9e7cbea31994c67ba5b86fd38bf6d91bd |
|
MD5 | e4a424dfae854bb7a163da44ce4911dd |
|
BLAKE2b-256 | 5c1db5cea4e626ce0d5da5ab5bb8ae57a57536caf517331468ca2956c9678892 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.167-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 432e17c5aea11e2d866959f42f7f6fe35eeaf3a29cc004e017ff569680f95606 |
|
MD5 | 881f7eda85ff908b24fbbb63f7c66798 |
|
BLAKE2b-256 | 5909d68ff300793602e10eb67352bd17062da24ed9086397c0d37a97a065c2ef |