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.913.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 842bbbc9c6fab44c9a17f108b6c6485d4e57d44538242da6b1b00a3dce876d9c |
|
MD5 | 6019b54aa6eb7aeb8a4170212d241ce8 |
|
BLAKE2b-256 | 9577ab0b59e47a15b9524870284c48db050dc243976e82e158e5236178f5300c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.913-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f91f6eb29855771c42b78df0befabc9d470e6484f7c8a99d7ec3f459a220975 |
|
MD5 | 469e7e47b2d3b489e1a001e167cff552 |
|
BLAKE2b-256 | 8710710c399f4ce3952543c2dce04358e9938595b59f33ae56bde8cfc61d563b |