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.143.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c49a1edc42edc60cc8b36cd927bdf03f746d4a38c2248232c9973affeba9cd9 |
|
MD5 | 348c4d381b2d8f6cefc9fabc2ec5cbd4 |
|
BLAKE2b-256 | 9771853f00c121decd13e9e254c5ca63d018db20ce76b81167f026494b738541 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.143-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c58c21c4535e18fab1d33b6e5ec01b82109828c088853a8c01bde17af3856a5d |
|
MD5 | 6c2750b9bda31dbb9e6d5c88fc36cb25 |
|
BLAKE2b-256 | 8ca092bd22152c144c867d203f74dde3e9d0d1310cad04d17d8a8fa96dafc011 |