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.912.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b68e4a3bc450ffa5e2679f4204a0fb42ec6ff2573cb49252cd59fe9cb9974162 |
|
MD5 | 7dce945a0bee6aab646228874bedc501 |
|
BLAKE2b-256 | 23fc8cea9eefe6df2e18437297f0fb83d547c132c16196a52c351cf3a49451ed |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.912-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e69ce3070783c0c482a255be89e9680a16541285985be8888d7a38a403f69d52 |
|
MD5 | f9ae02b9e10b83cc7b8ae09cf12f6b18 |
|
BLAKE2b-256 | 404a3f3180534def941f009103bb659e198302f3a2eafbf4449a55f6cef08000 |