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.433.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f32b5bfc62fa56ae32a0338258b480106c80be392865b4c2e5ff19dfbde94bf |
|
MD5 | d5b694a2a70a452bc86166288e195c0e |
|
BLAKE2b-256 | 067edb6939d83037b78c61953b8fbe00301e100d3f09363501e1b5e22979474f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.433-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 340d5dd04c5d08d52fb0555efaeb6404444a7adf28487b0b75bc306549515aa0 |
|
MD5 | 735f6b56537426ac92f87b532860e934 |
|
BLAKE2b-256 | 8b622f165fc9a2c47c074bd06063400fd6badf599c76cff185334d604624086f |