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.897.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc61d8d4fc6c6de9c5dd7a268c229d770efc1d42183c34b0f936c71220836757 |
|
MD5 | d19030f1f310b601f24b8ca9dc95afef |
|
BLAKE2b-256 | 952db6f6973af1e0a4f6a564f9041aebeebe83f00dfc79bc1dd9124b825a98b0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.897-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0555b94b572fe45d07a4cf46067998d92afddf53383da856c44a4cae9127ca32 |
|
MD5 | 75e66876a194e62577148b95850e13ce |
|
BLAKE2b-256 | 66e2b32827c1a3e65288059a9be4de11277974247a311d4e98c7e4b863cd85a2 |