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.282.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 677b99d25918f115a6885190d041dac8db293265da15597de5449fe69db9a0b0 |
|
MD5 | 151d00630f2eab0cca195815fc70dfb9 |
|
BLAKE2b-256 | b18690dad78f4ebd215c7c3cb21fd250e10f6dfe7c46ed4e2cb51b39cebb72eb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.282-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d555561bbb1c752c1d6b43950379a355419da8550b3dad355a0656428a037ba4 |
|
MD5 | cec037c71554528175375c87bba2dd7d |
|
BLAKE2b-256 | b657335ac728132e639e51e58b14e1a54a5e3110eee0e067fe3eff9e2094e246 |