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.533.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ff1b89a73852d34372b42b1f6233acfacb1395f564ed83bf186b2205b9cd1d7 |
|
MD5 | cfc710e173949f6a007abf7976d61d4a |
|
BLAKE2b-256 | aac512a5637a4252aa54a28b049cb02626c70be26e71c282c93478e42d6b89f1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.533-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 623ea8d2cd9c16d823132d003f4ce12824edaed2df085404b757b9ac1333fc9b |
|
MD5 | 9c72bd3915258df485ae7d3e389aeb4a |
|
BLAKE2b-256 | 70d7a78136e29df08eae66afff8e7bc313bcbd2a1ef9240e283e48ae830d3f72 |