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.147.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f14d8534e1002bc027aac463a62126265165109da0cabc7b2d24ac472b8c6d45 |
|
MD5 | 06201727e7b8d5b062d5aac7ec29b11a |
|
BLAKE2b-256 | 43b4dfd1df480bf1d9cda5bc0f9f217d22fa8e2e0aa84121d7572d9630add117 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.147-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 37065cb9ffa82c1c9242ba6c0f8f77cbe2c17d2db9a32aef82ef3bab2f4dd36f |
|
MD5 | 881789b3e11fe846fc715e071736367d |
|
BLAKE2b-256 | 5053349e1814f614e608c14d0edd8036417e69b002fed005ad455030156dfedc |