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.658.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 158d610f297a872b9d106cecf3b280e72aa2dc10812be7484e673f3c91387a1e |
|
MD5 | 4b2d1872cded9b082611fb61c8d1a257 |
|
BLAKE2b-256 | 00be42d0504cfb89f8cf020349e14a3a70b1ddd26038640be101a64a55330bb1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.658-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a6b5fff008178bb8f0d45fe98e4eeaec89d6d15d3417316bc0fe0941e296e9f |
|
MD5 | 6ab0923debc7287cd6b1862abca2b6c0 |
|
BLAKE2b-256 | a2ce43324283ae8865ba123a92632e022e96160525cf3a51a7e1b4bbbe835881 |