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.241.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ca07d7eac427421d919a3118e26985c671709a769c7a6c149379ec0679f20d2 |
|
MD5 | da7936861789504847c67228cd563433 |
|
BLAKE2b-256 | f20443fee9e333367876f7a93e49b33e45d1d4ac3a2f3011b2c7fadeedfe736c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.241-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5265f56ad4a77d41cf4d71dee47c50c027f4265c193f01f996fd705e7d1c56dc |
|
MD5 | 18247abd8f86cb85da4e3961d00951ec |
|
BLAKE2b-256 | 2ecf18c272efd6727c3642cd23f5ff6b81745b8aace75c8f76174e5d2edc910d |