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.858.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e1bbe485eb0fe7bb04e5556dbc3007e0f5e02bddb95f3f44cb907a3ff82ebcb4 |
|
MD5 | 50bc0c5e331a54c6c8b380d0ca150788 |
|
BLAKE2b-256 | 2550f9de7b7a00806697166f5c607b657a0490670f2f8735e5a284b10babaaa0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.858-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d0755493605cfc0615bb725ed7dd59c6a71f282cb4fa3a034c5fcf5f4b574b9 |
|
MD5 | 854f15ffb80063a86d905bd1408736f0 |
|
BLAKE2b-256 | 3d037ade273b05c04aa771a1601a14c873218bba9fe63b4f74cb0de3983db862 |