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.197.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9c2ba33124e0541bd234af9af0aad66bfcc345310943a0e167985add1d81120 |
|
MD5 | bb68107bf1f0e7e3c487c47dd1bba6ab |
|
BLAKE2b-256 | 60c846981754cb85135d50fc5278b1e4d57fdb3abd18e0687122d3c1b14ff206 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.197-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72fdc74200c153398e625127f05dad5c8c0533ca2b35939f74a5271253a42591 |
|
MD5 | fec13ced48c0d7eb4d25e5d95c411926 |
|
BLAKE2b-256 | a83ac8510ed38473b731ff89d7bb3ec06e9155c2c47c1045948398aa77305aa6 |