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.174.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0cb1fc8e96f68b52bc1939526ee304f5fde9d0fbff4e86b15aa3c93ef41b012c |
|
MD5 | b30402c55b30825d486f32cfd310866e |
|
BLAKE2b-256 | d6820d36f5e34406523050e2d92baa1768470326f8a247f8a05f95848e98ca63 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.174-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7060b5a91feaacd13498736f83c69d96dc2c6d06ffef71adfd3480684be9d3e1 |
|
MD5 | 6b61e6bdd7e515f14992b700cca7b373 |
|
BLAKE2b-256 | e4ce8c068d19ad6a3488cafe9d628b357951e76ea6a0adeab599999d0d08ea7f |