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.189.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6998cfe6234437a67ad1d1717d6ccef6fbd274725d29d7791542a95b82071292 |
|
MD5 | 84056ebcddb8b9fa8d54dbe1786f8c9b |
|
BLAKE2b-256 | 5710deff7709a899f33ccd7486dfb7280eeadca1d04b937f3864d83cbdd31e9e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.189-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6de4b55d5f448e4f273c92f6e6ca5dfe01845679ba784bf0b4dcb2749f4a888d |
|
MD5 | 8cea33bd64e8fade18a33aa8deca231f |
|
BLAKE2b-256 | a219dcc1c3d3431383853f3df9b634fafd26efbfbc30d476bf281bb5c1270d4a |