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.738.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd33f06c87c843a5b539bdf061bc7a6ebf50035ea7949c5160ff1d0d1dfaf4c8 |
|
MD5 | 3744371fa99c8556c6eaf7df80e06b77 |
|
BLAKE2b-256 | db4dd046cb35fd059b17aedb14395b8e51b79164ab3ac13fa8b31e0e139c644c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.738-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f61993d9cf7729c05e62e26075b2e4be6efa6ff1a3144d8ef53122803828e3a3 |
|
MD5 | 4233127e311bd45663a125aa403929ca |
|
BLAKE2b-256 | b608d0ff2fabd995d60eaa49ce672c19a95f6c64bbf963c58a363f2fd08aca57 |