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.863.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1f20095d1914ef83e2107dcd65cf1d4a83d121352cc7ab455c6c8ac69cc8f10 |
|
MD5 | cf7d7fd13424602eee113854c8f48538 |
|
BLAKE2b-256 | 4552ebafd50a303a748e5e667c1fbbd157226a8dedb0e3460912da7f12b4afbb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.863-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 485b2210d48955d1d4f02c2525fedacceecd953e6e364d1d560431fa9c23364f |
|
MD5 | 7a47d2026ee04ae9b5c8776c318082c5 |
|
BLAKE2b-256 | af527969b66bf820289bb77e49680578c4af04f7521d74364a8029fb0ee8826a |