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.264.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f88870c7feb2d65352af9f391e5c776382d5128e1918d51638bf450fc35a8dfe |
|
MD5 | 59b3ccb88af8c72101883df499b2a310 |
|
BLAKE2b-256 | 05d09cf9263e7a76aab1b5e602a1bc54f8774b56cc0bf3a97e967327a0a2e78e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.264-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa5605737d0c12862ca0a15f1c39f6cab920ac5b8dd37982e6a05f6225d01ffb |
|
MD5 | 81b1a74c4fe21234bb590d32b6f5af0a |
|
BLAKE2b-256 | c50ad8939bac2ed6bf6903f1e37f001759162b9dd0644f2a3d66904d14023b24 |