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.320.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ec5736e3203da9f582c8f581e069e5d50c96165986b5e899b9876230d119c73 |
|
MD5 | 4b97a18568126bd1f89bdb604f6cf5b7 |
|
BLAKE2b-256 | 976abaa69514089efbff2956d29e74161793ff02223dac6de79d04ce65d6bedc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.320-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b65f9828298796c75828d6cfa5eb26f4e8026e8ff7f73d45797410a179015ad |
|
MD5 | e73366279c03c10bbf0fa65d1578f477 |
|
BLAKE2b-256 | 077243185b5131f9a3bf43ed5ee5f1b913148f2c1d8db770b03b18ec63733f26 |