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.407.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1eeded40920001b6aff1ff13c3d6521169122ccbc7105f26e8ee2d77e6889505 |
|
MD5 | 18583e92ead464c8f19e760656c8d8e5 |
|
BLAKE2b-256 | 79706529a3ef2b84c709adbc5c10925f2f6c819846aed653877babb67bee35a6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.407-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08fce3878f0b2f8610ff3a0657af33d2a703a6a48593bb38c51139ce36fd8d3b |
|
MD5 | 9ad0a69e336198c02fac7bbe8563a729 |
|
BLAKE2b-256 | 260e49a864f34a477f23377dc5bf631f3b8e0815321aef380fc5872aabc4f590 |