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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9b309092d1b0b20c673993ed784d74e3d1b4f1a532bff192927d7e4d39acb81 |
|
MD5 | 9ff0e5102898fe7182b8acff332ba28e |
|
BLAKE2b-256 | 40de683a8b350f6bb1551578bc8a533034ff9c29cd6959f8082ada1ed44e75af |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eafc4c476ea8e6556bc27ca4f4289875acdb868f5a05114411abf3da085445d5 |
|
MD5 | 26760b59febfc94269257eafe7f93faa |
|
BLAKE2b-256 | 218293e702eff68b806ec2a7312a6f5308de11a924c70a918b7090c41fa44d9e |