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.744.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b55d7549541b2cd2c8b29048310e9818051db5e57c5b0fadd8758665a46d896 |
|
MD5 | 734fec12c89aac84dcf408d452ce23a0 |
|
BLAKE2b-256 | e488fa8b2ee3344356b5ed4830e4c6f7fd1b75bdfb3d919dccfb2f5606e12e94 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.744-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52f57c2cd962e0d7bd6303e3e0fac0f7abb28b199b3160f297994ed37f224e4d |
|
MD5 | 726067dd3e67ca6727c88399fec9c86c |
|
BLAKE2b-256 | 3ec94aaa2f412b437abb73f509553a5b961d142101609a0763687568e8b12d4d |