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.488.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a7ff747c4734f567cd5244439a6c2506ca6a8cb341550a660c9b88f60e870c9 |
|
MD5 | 7db0b542d5f84aedda8388ffe1ba0035 |
|
BLAKE2b-256 | 599d6af00faecc2ec9bd93ad86c74cde283a1788e08387e728bb2af0acd21573 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.488-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 444c782f78d26627c5e8b620d3f1d04a93aca1ab79e3745d0d24c9096107ddef |
|
MD5 | ed1bc3f2d4db9ccccd14f0a0529cb427 |
|
BLAKE2b-256 | db8e4535cbbfb050cb12e206227c3bcb9c85ec333448d24ee596299a504a9b1f |