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.478.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d47ad9468a1e2ff62bd168454a0679f99ff503110277dd1745b8b2f3e137204f |
|
MD5 | 1e81996c8085ed419e721735e1ba671a |
|
BLAKE2b-256 | 3f15a804128ded38cd8da517a88695cd69ebec017d92a20ca1a5d042613db9e7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.478-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27ffbb2b840273b32dd6c1cc25f70cdaaf898cf075b17088b9839d6750084637 |
|
MD5 | f4714a17333afb9f8a6ff5f6295da447 |
|
BLAKE2b-256 | 2bb2c7d6d7302dd0ff2a921ae2508657ee01249605fc2e5d695763bb75e54911 |