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.177.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38206e233bdf5a547f11ba1864080dc27a2a0e3cb26ff09897900a587904dcb3 |
|
MD5 | f8a76cbbd0a1fdd5f580680689a0e8bf |
|
BLAKE2b-256 | 137dc40017cf213704424e6262df37894fe4bc8905c4a4706d6896f4c6d076cc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.177-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d7cd7b5be7253f4a9a58bcb83c529e1459c0054c293856cecd1c15676757996 |
|
MD5 | 9c1fcf3f8c9430206c65ab118b71f72e |
|
BLAKE2b-256 | 216fbc1eb4a774235936818720d7ac3933b781294305aaa601297c5f03e8eae4 |