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.377.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8237565571ffa4e93103b2b8ee75f1b69b2d1ea7f5ef8e261bcc48e7340b84ad |
|
MD5 | a30afd3fd663aa27b01fede61f952a88 |
|
BLAKE2b-256 | 8085ed188a19cf0becc010e6d2349294f7d3bc8e409bcdec31bc583f789d9548 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.377-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8fde7219b024fe8cbe56e7fdc7de91627a21259d29ff3ce988434a6b1a09f6f7 |
|
MD5 | 20b14027f095dc43e669a65bb5fd5c48 |
|
BLAKE2b-256 | 5e271978b5b03cd1503dda2ca8b43c8e46b4c2469aa1138037f0c0edb0fac038 |