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.89.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b7a42f6b349ac893301b369d3d0da713b92798735ddae6b212439af1783a6b7 |
|
MD5 | 74aa985e82c5dbbe31158aade6a7e97b |
|
BLAKE2b-256 | 7eb2008e66658c95ca9036da245ae1af2a024fd0d8b5cc2d29b290ae59a46b4f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.89-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c5d6c6b35a7a2698fe84c4322d24ad14e1a21dc6e5ec7d75d48c7ecc420a8eb |
|
MD5 | 7a21de5feb88a5add2acdb9131b58db4 |
|
BLAKE2b-256 | 8b25bf8401549bbf6e317409958c58db649ade0b1795ffd233173be7e16d27b5 |