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.834.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | da578d6bb5c38621da9b514ba2cc9c71b2167958107661c0178cbdc0b695d06e |
|
MD5 | 2eeb22ab4b16bd539b1f6a559d65aac3 |
|
BLAKE2b-256 | 9444ad00cf1c675be71001c88afab026f493c59796a21863417989916ebdf862 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.834-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe62d5e7d0a443647e26b131d849c87111dd4b453788c557aee746174661498f |
|
MD5 | 730d59b4ec21242a0abc300b463f6fe9 |
|
BLAKE2b-256 | 696dc4f462b1f0c2dfb3ddbbaf8e745a4eaec0602460c47b7187b08873dd821f |