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.299.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6dae802b588d635588cfe20f9311fa1c46cce157c55f96512fd6376488fcff73 |
|
MD5 | 8bcf64f7ce48911c89b9ad346a31dc69 |
|
BLAKE2b-256 | 0d40dd54893b2b257ae72c8a8f31bbc3feabda4bf8821d6ab63af7d4a21209c7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.299-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 083df3cc2dda5f2c402b74ab20f7fc054012ca0c546923d8e618e72354adbe5b |
|
MD5 | a41e0d658ce35437b07715b4c2004cbb |
|
BLAKE2b-256 | 089103760c846f8396c5e4e26cda7ac6c9a85df731423f3b8b32aebfd726e503 |