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.515.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb2fb62534d6b1edaab783c54e8e67da0f6f57460f135672a3c75ce9a3a5f5fc |
|
MD5 | a5a47aa8a26d699ae7b42b105303b5c8 |
|
BLAKE2b-256 | db780eb05266ea225a237e888244d426c2a8059e88cde613996c2ebc13459686 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.515-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6308f49b20a10f746e4bdce09388a29e4b95e402b1bf37d55eb81cea1979a58c |
|
MD5 | bc649d78d050440cdeb7df7ff507467d |
|
BLAKE2b-256 | 78661fb7d8263ae58b503b84695b39c93b10d5428e304b96bc05dac5281cbc6d |