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.628.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1efd49373b7775a12e0e1152dc95eaff30963680d4b244d0d8b99be08ca09e03 |
|
MD5 | e139e2158b54b88a956d6124dfab7e08 |
|
BLAKE2b-256 | 151e54469a1568d17b713632c59f894a70717517de6aa0f53064d1f578d6fb76 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.628-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 004212a1c1ab8f620e6c8a3b02ac9f4814089b6feb8beee9a791c6a3dde432ee |
|
MD5 | 856773d594f434364b230aafb0ca65c9 |
|
BLAKE2b-256 | 20d8c16c2dddf30d47c13500f9c72ae68be0dd3676abeeab64b802f25fede559 |